jlj-qmk/keyboards/ergodox_ez/readme.md
Kurth O'Connor 7d08e48c50 Syntax update (#2660)
* initial commit

* init qmk keymap

* update docs

* update documentation

consolidate readme files; update `make` instructions
revise ascii keymap representation

* update documentation

* edit and update `make` syntax

- `make` syntax update
- fix typo
- add link to teensy video (already linked from online configurator)

* permissions restored

* remove superfluous files from branch

* reset idiosyncratic execute permissions

* reset idiosyncratic execute permission
2018-04-24 09:49:34 -07:00

42 lines
1.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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 <keyboardname>:<keymapname>`, for example `make ergodox_ez: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 corner.
- Click the button in the Teensy app to download the firmware.
See also [video demonstration](https://www.youtube.com/watch?v=9PyiGUO9_KQ) using Teensy in auto mode.
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.
## Settings
You may want to enable QMK_KEYS_PER_SCAN because the Ergodox has a relatively
slow scan rate.