aboutsummaryrefslogtreecommitdiff
path: root/keyboards/ergodone/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ergodone/readme.md')
-rw-r--r--keyboards/ergodone/readme.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/ergodone/readme.md b/keyboards/ergodone/readme.md
new file mode 100644
index 000000000..789819e67
--- /dev/null
+++ b/keyboards/ergodone/readme.md
@@ -0,0 +1,26 @@
1ErgoDone
2===
3
4![ErgoDone](https://i.imgur.com/QERsQGQ.jpg)
5
6ErgoDone 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.
7
8 - Keyboard Maintainer: [Yu He](http://github.com/yuhe00)
9 - Hardware Supported:
10 - ErgoDone ver. 1.3 (tested)
11 - Hardware Availability: [KBDFans](https://kbdfans.myshopify.com/collections/pcb/products/ergodone-keyboard-pcb-1pcs-free-shipping?variant=37178300237)
12
13Make example for this keyboard (after setting up your build environment):
14
15 make ergodox-ergodone-default
16
17See [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.
18
19# Flashing the keyboard
20
21The ErgoDone uses an HID bootloader rather than the Teensy one, and requires a different way of flashing the firmware.
22
231. While plugging in the USB cable, hold the two right-most keys on the left half of the ErgoDone to enter FLASH mode.
242. Use the `hid_bootloader_cli` utlity from [TKG Toolkit](https://github.com/kairyu/tkg-toolkit):
25
26 hid_bootloader_cli -mmcu=atmega32u4 ergodox_ergodone_default