summaryrefslogtreecommitdiff
path: root/keyboards/maple_computing/minidox/readme.md
diff options
context:
space:
mode:
authorpeepeetee <43021794+peepeetee@users.noreply.github.com>2022-01-31 03:28:04 +0800
committerGitHub <noreply@github.com>2022-01-30 11:28:04 -0800
commita1b39e6db231923935055846384eb2e78e538268 (patch)
treeeeaee7335efdff3d9ce960050882acf2cfe570a9 /keyboards/maple_computing/minidox/readme.md
parent07bb65384cf96be88feb2916604cb4a89cd0ad33 (diff)
downloadqmk_firmware-a1b39e6db231923935055846384eb2e78e538268.tar.gz
qmk_firmware-a1b39e6db231923935055846384eb2e78e538268.zip
[Keyboard] move That-Canadian 's boards into /maple_computing (#16050)
Diffstat (limited to 'keyboards/maple_computing/minidox/readme.md')
-rw-r--r--keyboards/maple_computing/minidox/readme.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/keyboards/maple_computing/minidox/readme.md b/keyboards/maple_computing/minidox/readme.md
new file mode 100644
index 0000000000..934985348c
--- /dev/null
+++ b/keyboards/maple_computing/minidox/readme.md
@@ -0,0 +1,27 @@
+# MiniDox
+
+![MiniDox](http://i.imgur.com/iWb3yO0.jpg)
+
+A compact version of the ErgoDox
+
+* Keyboard Maintainer: That-Canadian
+* Hardware Supported: MiniDox PCB rev1 Pro Micro
+
+Make example for this keyboard (after setting up your build environment):
+
+ make maple_computing/minidox/rev1:default
+
+Flashing example for this keyboard ([using the command line](https://docs.qmk.fm/#/newbs_flashing?id=flash-your-keyboard-from-the-command-line)):
+
+ make maple_computing/minidox/rev1:default:flash
+
+See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
+
+## Build Guide
+
+A build guide for putting together the MiniDox v1 can be found here: [MiniDox Build Log / Guide](http://imgur.com/a/vImo6)
+
+
+## Choosing which board to plug the USB cable into (choosing Master)
+
+Because the two boards are identical, the firmware has logic to differentiate the left and right board. It uses two strategies to figure things out, [EE_HANDS](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-eeprom) or [by define](https://docs.qmk.fm/#/feature_split_keyboard?id=handedness-by-define). See [setting-handedness](https://docs.qmk.fm/#/config_options?id=setting-handedness) for more information.