diff options
| author |  Erez Zukerman <ezuk@madmimi.com> | 2015-12-19 19:00:59 +0200 |
|---|---|---|
| committer | Erez Zukerman <ezuk@madmimi.com> | 2015-12-19 19:00:59 +0200 |
| commit | 11f07249513825677fa6b386f74ee6b368ea3e57 (patch) | |
| tree | 6cfe66a80894916c8170eeecef5eb3f82744ab31 /keyboard/ergodox_ez/README.md | |
| parent | 7f22b67f8ad61f12516ca75acd0d2277b94aa2a5 (diff) | |
| download | qmk_firmware-11f07249513825677fa6b386f74ee6b368ea3e57.tar.gz | |
Further clarifies README
Diffstat (limited to 'keyboard/ergodox_ez/README.md')
| -rw-r--r-- | keyboard/ergodox_ez/README.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/keyboard/ergodox_ez/README.md b/keyboard/ergodox_ez/README.md index cf40f79b2..de6b8edf9 100644 --- a/keyboard/ergodox_ez/README.md +++ b/keyboard/ergodox_ez/README.md @@ -16,9 +16,11 @@ This requires a little bit of familiarity with coding. 1. Go to https://github.com/jackhumbert/qmk_firmware and read the Readme at the base of this repository, top to bottom. Then come back here :) 2. Clone the repository (download it) 3. Set up a build environment as per https://www.pjrc.com/teensy/gcc.html -4. Customize the firmware to your liking and compile it -5. Flash it using the [Teensy loader](https://www.pjrc.com/teensy/loader.html) as described in step 4 above. -6. Submit your work as a pull request to this repository, so others can also use it. :) +4. Copy keymaps/keymap_default.c into keymaps/your_keymap_name.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. +6. Compile your firmware by running `make clean` followed by `make KEYMAP=your_keymap_name`. This will result in a hex file. +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. +7. Submit your work as a pull request to this repository, so others can also use it. :) Good luck! :) |