keyboards/ergodox_ez/readme.md

   1 # ErgoDox EZ
   2
   3 The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html).
   4
   5 Linux users need to modify udev rules as described on the [Teensy
   6 Linux page].  Some distributions provide a binary, maybe called
   7 `teensy-loader-cli`.
   8
   9 [Teensy Linux page]: https://www.pjrc.com/teensy/loader_linux.html
  10
  11 To flash the firmware:
  12
  13   - Build the firmware with `make keymapname`, for example `make default`
  14   - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
  15     `ergodox_ez_default.hex`
  16
  17   - Start the teensy loader.
  18
  19   - Load the .hex file into it.
  20
  21   - Press the Reset button by inserting a paperclip gently into the reset hole
  22     in the top right corder.
  23
  24   - Click the button in the Teensy app to download the firmware.
  25
  26 To flash with ´teensy-loader-cli´:
  27
  28   - Build the firmware with `make keymapname`, for example `make default`
  29
  30   - Run ´<path/to/>teensy_loader_cli -mmcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
  31
  32   - Press the Reset button by inserting a paperclip gently into the reset hole
  33     in the top right corder.