summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--keyboards/ergodone/readme.md34
1 files changed, 20 insertions, 14 deletions
diff --git a/keyboards/ergodone/readme.md b/keyboards/ergodone/readme.md
index 9d7057a396..8e3123f4f2 100644
--- a/keyboards/ergodone/readme.md
+++ b/keyboards/ergodone/readme.md
@@ -1,27 +1,33 @@
ErgoDone
-===
+========
![ErgoDone](https://i.imgur.com/QERsQGQ.jpg)
-ErgoDone is a modified ErgoDox with pre-soldered components made by K.T.E.C. It has different wiring and uses a Pro Micro instead of Teensy.
+The ErgoDone is a modified version of the ErgoDox, made by K.T.E.C., with pre-soldered components. It has different wiring and uses a SparkFun Pro Micro instead of Teensy.
- - Keyboard Maintainer: [Yu He](http://github.com/yuhe00)
- - Hardware Supported:
- - ErgoDone ver. 1.3 (tested)
- - Hardware Availability: [KBDFans](https://kbdfans.myshopify.com/collections/pcb/products/ergodone-keyboard-pcb-1pcs-free-shipping?variant=37178300237)
+- Keyboard maintainer: [Yu He](http://github.com/yuhe00)
+- Hardware supported:
+ - ErgoDone v1.3 (tested)
+- Hardware availability:
+ - [AliExpress](https://www.aliexpress.com/store/product/ergodone-Custom-Mechanical-Keyboard-TKG-TOOLS-PCB-programmed-Ergonomic-Keyboard-Kit-similar-with-infinity-ergodox/3034003_32830050940.html)
+ - [KBDfans](https://kbdfans.myshopify.com/collections/pcb/products/ergodone-keyboard-pcb-1pcs-free-shipping)
-Make example for this keyboard (after setting up your build environment):
+# Building the firmware
+
+[Install the build tools.](https://docs.qmk.fm/getting_started_build_tools.html)
+
+In the root directory of the repository, build the firmware with a command like:
make ergodone-default
-See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
+For more information on the layout option and other ones, see the [`make` guide](https://docs.qmk.fm/getting_started_make_guide.html).
-# Flashing the keyboard
+# Flashing the firmware onto the keyboard
-The ErgoDone uses an HID bootloader rather than the Teensy one, and requires a different way of flashing the firmware.
+The ErgoDone uses a customized HID bootloader rather than the Teensy one. It doesn't need an OS driver, and the required actions before flashing are a little different than with an ErgoDox.
-1. While plugging in the USB cable, hold the two right-most keys on the top row of the left half of the ErgoDone to enter FLASH mode and flash a hex file.
+1. To enter flash mode, disconnect the keyboard first. Then, on the left-hand device, in the top row, press and hold the two rightmost keys while reconnecting the keyboard.
![Ergodone Flash Mode](https://i.imgur.com/sNivAnr.jpg)
-2. Use the `hid_bootloader_cli` utlity from [TKG Toolkit](https://github.com/kairyu/tkg-toolkit):
-
- hid_bootloader_cli -mmcu=atmega32u4 ergodox_ergodone_default
+2. To flash the .hex file, use the `hid_bootloader_cli` utlity from the [TKG Toolkit](https://github.com/kairyu/tkg-toolkit) (as of 2017-10-03, only [this old version](https://github.com/kairyu/tkg-toolkit/blob/b14c67ca8bc84c07e5fc6b2e01ae4002b808243a/windows/bin/hid_bootloader_cli.exe) works under Windows):
+
+ hid_bootloader_cli -mmcu=atmega32u4 ergodone_default.hex