diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-08-23 22:29:07 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-08-23 22:29:07 -0400 |
| commit | d2ff66a985b938e87fffe55c1d9f1dc55e356f91 (patch) | |
| tree | 561b3e203033849573a17f5ac6248077ab687676 /keyboards/ergodox_ez/readme.md | |
| parent | 7260fc3eef98fb7b0e2ed24d3d0d14cf2e613000 (diff) | |
Creates a layouts/ folder for keymaps shared between keyboards (#1609)
* include variables and .h files as pp directives
* start layout compilation
* split ergodoxes up
* don't compile all layouts for everything
* might seg fault
* reset layouts variable
* actually reset layouts
* include rules.mk instead
* remove includes from rules.mk
* update variable setting
* load visualizer from path
* adds some more examples
* adds more layouts
* more boards added
* more boards added
* adds documentation for layouts
* use lowercase names for LAYOUT_
* add layout.json files for each layout
* add community folder, default keymaps for layouts
* touch-up default layouts
* touch-up layouts, some keyboard rules.mk
* update documentation for layouts
* fix up serial/i2c switches
Diffstat (limited to 'keyboards/ergodox_ez/readme.md')
| -rw-r--r-- | keyboards/ergodox_ez/readme.md | 33 |
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 0000000000..f025c5991d --- /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. |