diff options
Diffstat (limited to 'keyboards/ergodox/readme.md')
| -rw-r--r-- | keyboards/ergodox/readme.md | 34 |
1 files changed, 23 insertions, 11 deletions
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md index 3bbe98fd69..3d6fb455a0 100644 --- a/keyboards/ergodox/readme.md +++ b/keyboards/ergodox/readme.md @@ -1,5 +1,7 @@ # The Easy Way +If you have an ErgoDox EZ, the absolute easiest way for you to customize your firmware is using the [graphical configurator](http://configure.ergodox-ez.com), which uses QMK under the hood. + If you can find firmware someone else has made that does what you want, that is the easiest way to customize your ErgoDox. It requires no programming experience or the setup of a build environment. @@ -23,7 +25,7 @@ If none of the existing keymaps suit you, you can create your own custom keymap. This will require some experience with coding. Follow these steps to customize a keymap: - - Read the [qmk firmware README](https://github.com/jackhumbert/qmk_firmware) from top to bottom. Then come back here. :) + - Read the [qmk firmware README](https://github.com/qmk/qmk_firmware) from top to bottom. Then come back here. :) - Clone the qmk_firmware repository @@ -63,16 +65,20 @@ files. Check them out with: # Flashing Firmware -## ErgoDox Ez +## 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`). +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` + - 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` @@ -85,6 +91,15 @@ To flash the firmware: - 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 --mcu=atmega32u4 -w ergodox_ez_<keymap>.hex´ + + - Press the Reset button by inserting a paperclip gently into the reset hole + in the top right corder. + ## ErgoDox Infinity The Infinity is two completely independent keyboards, and needs to be flashed @@ -98,7 +113,7 @@ for the left and right halves seperately. To flash them: - Install the firmware with `sudo make infinity-keymapname-dfu-util` - - Build left hand firmware with `make infinity-keymapname MASTER=right` + - Build right hand firmware with `make infinity-keymapname MASTER=right` - Plug in the right hand keyboard only. @@ -153,13 +168,10 @@ If you want to send a plain vanilla key, you can look up its code under `doc/key There are external tools for customizing the layout, but those do not use the featurs of this qmk firmware. These sites include: - - [Massdrop configurator](https://keyboard-configurator.massdrop.com/ext/ergodox) for Ez + - The official [ErgoDox EZ configurator](http://configure.ergodox-ez.com) + - [Massdrop configurator](https://keyboard-configurator.massdrop.com/ext/ergodox) for EZ, works but not officially supported - [Input Club configurator](https://input.club/configurator-ergodox) for Infinity, provides left and right files You can also find an existing firmware that you like, for example from: - [Dozens of community-contributed keymaps](http://qmk.fm/keyboards/ergodox/) - -This qmk firmware also provides the ability to customize keymaps, but requires -a toolchain to build the firmware. See below for instructions on building -firmware and customizing keymaps. |