keyboard/qmk-keychron-q3-colemak-dh
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
e0690096f8
qmk-keychron-q3-colemak-dh/keyboards/ergodox_ez/readme.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

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
2017-08-24 04:29:07 +02:00
# 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:
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 18:49:34 +02:00
- Build the firmware with `make <keyboardname>:<keymapname>`, for example `make ergodox_ez:default`
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
2017-08-24 04:29:07 +02:00
- 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
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 18:49:34 +02:00
in the top right corner.
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
2017-08-24 04:29:07 +02:00
- Click the button in the Teensy app to download the firmware.
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 18:49:34 +02:00
See also [video demonstration](https://www.youtube.com/watch?v=9PyiGUO9_KQ) using Teensy in auto mode.
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
2017-08-24 04:29:07 +02:00
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.
Allow multiple process_record() calls per scan This is particularly relevant for, e.g., the ergodox EZ and other keyboards with slow scan rates. Without changing the API or behavior of individual process_record() calls, we allow a configuration flag to make multiple calls in a single scan. This will probably have miniscule effects on non-steno users, and it's not enabled by default for any keyboards. Added note about it to ergodox README. Signed-off-by: seebs <seebs@seebs.net>
2017-11-18 22:39:50 +01:00
## Settings
You may want to enable QMK_KEYS_PER_SCAN because the Ergodox has a relatively
slow scan rate.
Reference in New Issue Copy Permalink