aboutsummaryrefslogtreecommitdiffstats
path: root/keyboards/ergodox_ez/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ergodox_ez/readme.md')
-rw-r--r--keyboards/ergodox_ez/readme.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/keyboards/ergodox_ez/readme.md b/keyboards/ergodox_ez/readme.md
new file mode 100644
index 000000000..f025c5991
--- /dev/null
+++ b/keyboards/ergodox_ez/readme.md
@@ -0,0 +1,33 @@
+# ErgoDox EZ
+
+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`.
+
+[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`
+ - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
+ `ergodox_ez_default.hex`
+
+ - Start the teensy loader.
+
+ - Load the .hex file into it.
+
+ - Press the Reset button by inserting a paperclip gently into the reset hole
+ in the top right corder.
+
+ - 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 -mmcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
+
+ - Press the Reset button by inserting a paperclip gently into the reset hole
+ in the top right corder.