]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
Updates readme
authorErez Zukerman <ezuk@madmimi.com>
Wed, 23 Dec 2015 13:28:13 +0000 (15:28 +0200)
committerErez Zukerman <ezuk@madmimi.com>
Wed, 23 Dec 2015 13:28:13 +0000 (15:28 +0200)
keyboard/ergodox_ez/README.md

index de6b8edf90c9cb3dec2225ef7424dde890450e15..8085e5cd8729c3812559218f98033b34d85e0c9c 100644 (file)
@@ -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. :)