diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-03-29 09:45:22 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-29 09:45:22 -0400 |
| commit | 942f2ccee44bdb2e251553e9730cd8d59307d8b2 (patch) | |
| tree | a15c54c9f2298bc6bbb92912539805daf7c71a3f | |
| parent | 23839b8c6d2f955e4da89b0981948c721346c528 (diff) | |
| parent | d6e51d20084921481acacde7546ff08d790b898d (diff) | |
| download | qmk_firmware-942f2ccee44bdb2e251553e9730cd8d59307d8b2.tar.gz qmk_firmware-942f2ccee44bdb2e251553e9730cd8d59307d8b2.zip | |
Merge pull request #1183 from Rovanion/real-master
Added instructions for how to build and flash the firmware with teensy_cli
| -rw-r--r-- | keyboards/ergodox/readme.md | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/keyboards/ergodox/readme.md b/keyboards/ergodox/readme.md index 5e50548be..3d6fb455a 100644 --- a/keyboards/ergodox/readme.md +++ b/keyboards/ergodox/readme.md | |||
| @@ -1,6 +1,6 @@ | |||
| 1 | # The Easy Way | 1 | # The Easy Way |
| 2 | 2 | ||
| 3 | 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. | 3 | 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. |
| 4 | 4 | ||
| 5 | If you can find firmware someone else has made that does what you want, that | 5 | If you can find firmware someone else has made that does what you want, that |
| 6 | is the easiest way to customize your ErgoDox. It requires no programming | 6 | is the easiest way to customize your ErgoDox. It requires no programming |
| @@ -69,12 +69,16 @@ files. Check them out with: | |||
| 69 | 69 | ||
| 70 | The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html). | 70 | The Ez uses the [Teensy Loader](https://www.pjrc.com/teensy/loader.html). |
| 71 | 71 | ||
| 72 | Linux users need to modify udev rules as described on the Teensy Linux page. | 72 | Linux users need to modify udev rules as described on the [Teensy |
| 73 | Some distributions provide a binary, maybe called `teensy-loader-cli`). | 73 | Linux page]. Some distributions provide a binary, maybe called |
| 74 | `teensy-loader-cli`. | ||
| 75 | |||
| 76 | [Teensy Linux page]: https://www.pjrc.com/teensy/loader_linux.html | ||
| 74 | 77 | ||
| 75 | To flash the firmware: | 78 | To flash the firmware: |
| 76 | 79 | ||
| 77 | - Build the firmware with `make keymapname`, for example `make default` | 80 | - Build the firmware with `make keymapname`, for example `make default` |
| 81 | |||
| 78 | - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g. | 82 | - This will result in a hex file called `ergodox_ez_keymapname.hex`, e.g. |
| 79 | `ergodox_ez_default.hex` | 83 | `ergodox_ez_default.hex` |
| 80 | 84 | ||
| @@ -87,6 +91,15 @@ To flash the firmware: | |||
| 87 | 91 | ||
| 88 | - Click the button in the Teensy app to download the firmware. | 92 | - Click the button in the Teensy app to download the firmware. |
| 89 | 93 | ||
| 94 | To flash with ´teensy-loader-cli´: | ||
| 95 | |||
| 96 | - Build the firmware with `make keymapname`, for example `make default` | ||
| 97 | |||
| 98 | - Run ´<path/to/>teensy_loader_cli --mcu=atmega32u4 -w ergodox_ez_<keymap>.hex´ | ||
| 99 | |||
| 100 | - Press the Reset button by inserting a paperclip gently into the reset hole | ||
| 101 | in the top right corder. | ||
| 102 | |||
| 90 | ## ErgoDox Infinity | 103 | ## ErgoDox Infinity |
| 91 | 104 | ||
| 92 | The Infinity is two completely independent keyboards, and needs to be flashed | 105 | The Infinity is two completely independent keyboards, and needs to be flashed |