qmk-keychron-q3-colemak-dh/keyboards/ergodone/readme.md

ErgoDone
========

![ErgoDone](https://i.imgur.com/QERsQGQ.jpg)

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 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)

# 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

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 firmware onto the keyboard

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. 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. 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
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00			`ErgoDone`
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			`========`
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
			`![ErgoDone](https://i.imgur.com/QERsQGQ.jpg)`

ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			`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.`
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			`- 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)`
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			`# 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:`
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
Make arguments redo, subproject elimination (#1784) * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * redo make args to use colons, better folder structuring system [skip ci] * don't put spaces after statements - hard lessons in makefile development * fix-up some other rules.mk * give travis a chance * reset KEYMAPS variable * start converting keyboards to new system * try making all with travis * start to update readmes and keyboards * look in keyboard directories for board.mk * update visualizer rules * fix up some other keyboards/keymaps * fix arm board ld includes * fix board rules * fix up remaining keyboards * reset layout variable * reset keyboard_layouts * fix remainging keymaps/boards * update readmes, docs * add note to makefile error * update readmes * remove planck keymap warnings * update references and docs * test out tarvis build stages * don't use stages for now * don't use stages for now 2017-10-14 23:32:19 +02:00			`make ergodone:default`
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			For more information on the layout option and other ones, see the [`make` guide](https://docs.qmk.fm/getting_started_make_guide.html).
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			`# Flashing the firmware onto the keyboard`
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			`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.`
Add separate readme.md for ErgoDone 2017-08-15 12:22:14 +02:00
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			`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.`
Further updated ergodone readme.md (#1714) * updated read.md file * added image to flash hex on ergodone * corrected image link * updated direct image link * image with larger text 2017-09-14 19:05:29 +02:00			`![Ergodone Flash Mode](https://i.imgur.com/sNivAnr.jpg)`
ErgoDone keyboard: Improved structure of readme and augmented it with important information. Updated links to moved content. 2017-10-03 18:43:18 +02:00			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`