diff options
| author | Yu He <yuhe00@gmail.com> | 2017-08-15 12:22:14 +0200 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-08-16 17:31:12 -0400 |
| commit | 4c2dafc652b9f1464e196acb875e973502af4812 (patch) | |
| tree | e12191a305e74371bb1b6893f27d2428b322cceb /keyboards/ergodox/ergodone | |
| parent | 285099de0d7cced77351f11556489eb6ccebbd0f (diff) | |
Add separate readme.md for ErgoDone
Diffstat (limited to 'keyboards/ergodox/ergodone')
| -rw-r--r-- | keyboards/ergodox/ergodone/readme.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/ergodox/ergodone/readme.md b/keyboards/ergodox/ergodone/readme.md new file mode 100644 index 0000000000..789819e67a --- /dev/null +++ b/keyboards/ergodox/ergodone/readme.md @@ -0,0 +1,26 @@ +ErgoDone +=== + + + +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. + + - 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) + +Make example for this keyboard (after setting up your build environment): + + make ergodox-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. + +# Flashing the keyboard + +The ErgoDone uses an HID bootloader rather than the Teensy one, and requires a different way of flashing the firmware. + +1. While plugging in the USB cable, hold the two right-most keys on the left half of the ErgoDone to enter FLASH mode. +2. Use the `hid_bootloader_cli` utlity from [TKG Toolkit](https://github.com/kairyu/tkg-toolkit): + + hid_bootloader_cli -mmcu=atmega32u4 ergodox_ergodone_default |