summaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-03-29 09:45:22 -0400
committerGitHub <noreply@github.com>2017-03-29 09:45:22 -0400
commit942f2ccee44bdb2e251553e9730cd8d59307d8b2 (patch)
treea15c54c9f2298bc6bbb92912539805daf7c71a3f /keyboards/ergodox
parent23839b8c6d2f955e4da89b0981948c721346c528 (diff)
parentd6e51d20084921481acacde7546ff08d790b898d (diff)
Merge pull request #1183 from Rovanion/real-master
Added instructions for how to build and flash the firmware with teensy_cli
Diffstat (limited to 'keyboards/ergodox')
-rw-r--r--keyboards/ergodox/readme.md21
1 files changed, 17 insertions, 4 deletions
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md
index 5e50548be3..3d6fb455a0 100644
--- a/keyboards/ergodox/readme.md
+++ b/keyboards/ergodox/readme.md
@@ -1,6 +1,6 @@
# The Easy Way
-If 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.
+If 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.
If you can find firmware someone else has made that does what you want, that
is the easiest way to customize your ErgoDox. It requires no programming
@@ -69,12 +69,16 @@ files. Check them out with:
The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
-Linux users need to modify udev rules as described on the Teensy Linux page.
-Some distributions provide a binary, maybe called `teensy-loader-cli`).
+Linux users need to modify udev rules as described on the [Teensy
+Linux page]. Some distributions provide a binary, maybe called
+`teensy-loader-cli`.
+
+[Teensy Linux page]: https://www.pjrc.com/teensy/loader_linux.html
To flash the firmware:
- - Build the firmware with `make keymapname`, for example `make default`
+ - Build the firmware with `make keymapname`, for example `make default`
+
- This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
`ergodox_ez_default.hex`
@@ -87,6 +91,15 @@ To flash the firmware:
- Click the button in the Teensy app to download the firmware.
+To flash with ´teensy-loader-cli´:
+
+ - Build the firmware with `make keymapname`, for example `make default`
+
+ - Run ´<path/to/>teensy_loader_cli --mcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
+
+ - Press the Reset button by inserting a paperclip gently into the reset hole
+ in the top right corder.
+
## ErgoDox Infinity
The Infinity is two completely independent keyboards, and needs to be flashed