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 <keyboardname>:<keymapname>`, for example `make ergodox_ez:default`
  14
  15   - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g.
  16     `ergodox_ez_default.hex`
  17
  18   - Start the teensy loader.
  19
  20   - Load the .hex file into it.
  21
  22   - Press the Reset button by inserting a paperclip gently into the reset hole
  23     in the top right corner.
  24
  25   - Click the button in the Teensy app to download the firmware.
  26
  27 See also [video demonstration](https://www.youtube.com/watch?v=9PyiGUO9_KQ) using Teensy in auto mode.
  28
  29 To flash with ´teensy-loader-cli´:
  30
  31   - Build the firmware with `make keymapname`, for example `make default`
  32
  33   - Run ´<path/to/>teensy_loader_cli -mmcu=atmega32u4 -w ergodox_ez_<keymap>.hex´
  34
  35   - Press the Reset button by inserting a paperclip gently into the reset hole
  36     in the top right corder.
  37
  38 ## Settings
  39
  40 You may want to enable QMK_KEYS_PER_SCAN because the Ergodox has a relatively
  41 slow scan rate.