diff options
| author | Erez Zukerman <ezuk@madmimi.com> | 2015-12-23 14:28:13 +0100 |
|---|---|---|
| committer | Erez Zukerman <ezuk@madmimi.com> | 2015-12-23 14:28:13 +0100 |
| commit | 58e237d2dc77450b5831701ad2a93de305c044ca (patch) | |
| tree | 5dc15d3d7f4670d698068067bb8304a183c543d0 /keyboard/ergodox_ez | |
| parent | 694fe4e1e2d7ddfbd964013fbd2546e38c65d38c (diff) | |
| download | qmk_firmware-58e237d2dc77450b5831701ad2a93de305c044ca.tar.gz qmk_firmware-58e237d2dc77450b5831701ad2a93de305c044ca.tar.xz | |
Updates readme
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 de6b8edf9..8085e5cd8 100644 --- a/keyboard/ergodox_ez/README.md +++ b/keyboard/ergodox_ez/README.md @@ -16,9 +16,9 @@ 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. Copy keymaps/keymap_default.c into keymaps/your_keymap_name.c +4. Copy `keymaps/keymap_default.c` into `keymaps/keymaps_your_name.c` (for example, `keymaps/keymap_german.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. Compile your firmware by running `make clean` followed by `make KEYMAP=your_name`. Note that you must omit the `keymap_` prefix for your filename in this command -- 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. 7. Submit your work as a pull request to this repository, so others can also use it. :) |