diff options
Diffstat (limited to 'quantum/template/readme.md')
| -rw-r--r-- | quantum/template/readme.md | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/quantum/template/readme.md b/quantum/template/readme.md index b16f4cd76..33562764d 100644 --- a/quantum/template/readme.md +++ b/quantum/template/readme.md | |||
| @@ -7,22 +7,30 @@ For the full Quantum feature list, see [the parent readme](/). | |||
| 7 | 7 | ||
| 8 | ## Building | 8 | ## Building |
| 9 | 9 | ||
| 10 | Download or clone the whole firmware and navigate to the keyboards/%KEYBOARD% folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex - you can then use the Teensy Loader to program your .hex file. | 10 | Download or clone the whole firmware and navigate to the root folder. Once your dev env is setup, you'll be able to type `make %KEYBOARD%-default` to generate your .hex - you can then use the Teensy Loader to program your .hex file. |
| 11 | |||
| 12 | (Note: replace %KEYBOARD% with the name of your keyboard.) | ||
| 11 | 13 | ||
| 12 | Depending on which keymap you would like to use, you will have to compile slightly differently. | 14 | Depending on which keymap you would like to use, you will have to compile slightly differently. |
| 13 | 15 | ||
| 14 | ### Default | 16 | ### Default |
| 15 | 17 | ||
| 16 | To build with the default keymap, simply run `make default`. | 18 | To build with the default keymap, simply run `make %KEYBOARD%-default`. |
| 17 | 19 | ||
| 18 | ### Other Keymaps | 20 | ### Other Keymaps |
| 19 | 21 | ||
| 20 | Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder, and see keymap documentation (you can find in top readme.md) and existant keymap files. | 22 | Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create a folder with the name of your keymap in the keymaps folder. Create a `readme.md` and a `keymap.c` file to complete your new keymap. When you are done your file tree should look like this: |
| 23 | |||
| 24 | * `qmk_firmware/` | ||
| 25 | * `keyboard/` | ||
| 26 | * `keymaps/` | ||
| 27 | * `config.h` (optional) | ||
| 28 | * `keymap.c` | ||
| 29 | * `readme.md` | ||
| 30 | * `rules.mk` (optional) | ||
| 21 | 31 | ||
| 22 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: | 32 | To build the firmware binary hex file with a keymap just do `make` with a keymap like this: |
| 23 | 33 | ||
| 24 | ``` | 34 | ``` |
| 25 | $ make [default|jack|<name>] | 35 | $ make %KEYBOARD%-[default|jack|<name>] |
| 26 | ``` | 36 | ``` |
| 27 | |||
| 28 | Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. | ||