diff options
| author | Hartmut Goebel <htgoebel@users.noreply.github.com> | 2016-05-31 16:03:04 +0200 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2016-05-31 10:03:04 -0400 |
| commit | cea4b9a4bb4090b20612a43efa3378b95a6dcac0 (patch) | |
| tree | 3532b3cc60d50d203a1fc6c619593a72fd2c92ae /keyboard/ergodox_ez | |
| parent | 8ee9be11dee3db265cd8a0cc22a8fe40f6067820 (diff) | |
| download | qmk_firmware-cea4b9a4bb4090b20612a43efa3378b95a6dcac0.tar.gz qmk_firmware-cea4b9a4bb4090b20612a43efa3378b95a6dcac0.zip | |
Update to Makefile an ergodox readme (#365)
* Autodetect teensy-loader-cli over teensy_loader_cli.
Some distributions (e.g. Arch Linux, Guix) install teensy_loader_cli
as teensy-loader-cli. Use this one if it is installed.
* Update ergodox_ez/readme.md
- Mention Linux distris providing teensy-loader-cli
- Mention `make teensy ...`
Diffstat (limited to 'keyboard/ergodox_ez')
| -rw-r--r-- | keyboard/ergodox_ez/readme.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/keyboard/ergodox_ez/readme.md b/keyboard/ergodox_ez/readme.md index 97a10ff4d8..59130129cd 100644 --- a/keyboard/ergodox_ez/readme.md +++ b/keyboard/ergodox_ez/readme.md @@ -4,7 +4,7 @@ There are two main ways you could customize the ErgoDox EZ. ## The Easy Way: Use an existing firmware file and just flash it -1. Download and install the [Teensy Loader](https://www.pjrc.com/teensy/loader.html) +1. Download and install the [Teensy Loader](https://www.pjrc.com/teensy/loader.html). Some Linux distributions already provide a binary (may be called `teensy-loader-cli`), so you may prefer to use this. 2. Find a firmware file you like. You can find a few if these in the keymaps subdirectory right here. The file you need ends with .hex, and you can look at its .c counterpart (or its PNG image) to see what you'll be getting. You can also use the [Massdrop configurator](https://keyboard-configurator.massdrop.com/ext/ergodox) to create a firmware Hex file you like. 3. Download the firmware file 4. Connect the keyboard, press its Reset button (gently insert a paperclip into the hole in the top-right corner) and flash it using the Teensy loader you installed on step 1 and the firmware you downloaded. @@ -20,7 +20,7 @@ This requires a little bit of familiarity with coding. 4. Copy `keyboard/ergodox_ez/keymaps/default/keymap.c` into `keymaps/your_name/keymap.c` (for example, `keymaps/german/keymap.c`) 5. Edit this file, changing keycodes to your liking (see "Finding the keycodes you need" below). Try to edit the comments as well, so the "text graphics" represent your layout correctly. See below for more tips on sharing your work. 6. Compile your firmware by running `make clean` followed by `make KEYMAP=your_name`. For example, `make KEYMAP=german`. This will result in a hex file, which will always be called `ergodox_ez.hex`, regardless of your keymap name. -6. Flash this hex file using the [Teensy loader](https://www.pjrc.com/teensy/loader.html) as described in step 4 in the "Easy Way" above. +6. Flash this hex file using the [Teensy loader](https://www.pjrc.com/teensy/loader.html) as described in step 4 in the "Easy Way" above. If you prefer you can automatically flash the hex file after successfull build by running `make teensy KEYMAP=your_name`. 7. Submit your work as a pull request to this repository, so others can also use it. :) See below on specifics. Good luck! :) |