keyboards/ergodone/readme.md

   1 ErgoDone
   2 ========
   3
   4 ![ErgoDone](https://i.imgur.com/QERsQGQ.jpg)
   5
   6 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.
   7
   8 - Keyboard maintainer: [Yu He](http://github.com/yuhe00)
   9 - Hardware supported:
  10     - ErgoDone v1.3 (tested)
  11 - Hardware availability:
  12     - [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)
  13     - [KBDfans](https://kbdfans.myshopify.com/collections/pcb/products/ergodone-keyboard-pcb-1pcs-free-shipping)
  14
  15 # Building the firmware
  16
  17 [Install the build tools.](https://docs.qmk.fm/getting_started_build_tools.html)
  18
  19 In the root directory of the repository, build the firmware with a command like:
  20
  21     make ergodone:default
  22
  23 For more information on the layout option and other ones, see the [`make` guide](https://docs.qmk.fm/getting_started_make_guide.html).
  24
  25 # Flashing the firmware onto the keyboard
  26
  27 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.
  28
  29 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.
  30 ![Ergodone Flash Mode](https://i.imgur.com/sNivAnr.jpg)
  31 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):
  32
  33        hid_bootloader_cli -mmcu=atmega32u4 ergodone_default.hex