aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRovanion Luckey <rovanion.luckey@gmail.com>2017-01-24 10:02:56 +0100
committerRovanion Luckey <rovanion.luckey@gmail.com>2017-01-24 10:02:56 +0100
commit18cc05e2f7d09f9faac37ee504bd111e70a52764 (patch)
treef191da3f74fe76bcdcdf5104d7786af8b85587d3
parent71137deba21bfc392d60cffb1b76216c362beb9a (diff)
downloadqmk_firmware-18cc05e2f7d09f9faac37ee504bd111e70a52764.tar.gz
qmk_firmware-18cc05e2f7d09f9faac37ee504bd111e70a52764.zip
Added instructions for how to build and flash the firmware with teensy_cli.
-rw-r--r--keyboards/ergodox/readme.md18
1 files changed, 14 insertions, 4 deletions
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
index ca3eeba59..d7eed8f43 100644
--- a/keyboards/ergodox/readme.md
+++ b/keyboards/ergodox/readme.md
@@ -1,6 +1,6 @@
1# The Easy Way 1# The Easy Way
2 2
3If you have an ErgoDox EZ, the absolute easiest way for you to customize your firmware is using the [graphical configurator](http://configure.ergodox-ez.com), which uses QMK under the hood. 3If you have an ErgoDox EZ, the absolute easiest way for you to customize your firmware is using the [graphical configurator](http://configure.ergodox-ez.com), which uses QMK under the hood.
4 4
5If you can find firmware someone else has made that does what you want, that 5If you can find firmware someone else has made that does what you want, that
6is the easiest way to customize your ErgoDox. It requires no programming 6is the easiest way to customize your ErgoDox. It requires no programming
@@ -69,12 +69,13 @@ files. Check them out with:
69 69
70The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html). 70The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
71 71
72Linux users need to modify udev rules as described on the Teensy Linux page. 72Linux users need to modify udev rules as described on the Teensy Linux page (which page?).
73Some distributions provide a binary, maybe called `teensy-loader-cli`). 73Some distributions provide a binary, maybe called `teensy-loader-cli`.
74 74
75To flash the firmware: 75To flash the firmware:
76 76
77 - Build the firmware with `make keymapname`, for example `make default` 77 - Build the firmware with `make keymapname`, for example `make default`
78
78 - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g. 79 - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
79 `ergodox_ez_default.hex` 80 `ergodox_ez_default.hex`
80 81
@@ -87,6 +88,15 @@ To flash the firmware:
87 88
88 - Click the button in the Teensy app to download the firmware. 89 - Click the button in the Teensy app to download the firmware.
89 90
91To flash with ´teensy-loader-cli´:
92
93 - Build the firmware with `make keymapname`, for example `make default`
94
95 - Run ´<path/to/>teensy_loader_cli --mcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
96
97 - Press the Reset button by inserting a paperclip gently into the reset hole
98 in the top right corder.
99
90## ErgoDox Infinity 100## ErgoDox Infinity
91 101
92The Infinity is two completely independent keyboards, and needs to be flashed 102The Infinity is two completely independent keyboards, and needs to be flashed