diff options
| author |  Olivier <olivier@gid0.org> | 2016-11-27 23:23:21 +0100 |
|---|---|---|
| committer | Olivier <olivier@gid0.org> | 2016-11-27 23:23:21 +0100 |
| commit | d6d0b7eadaa568853b21d74057db306a33b7a847 (patch) | |
| tree | e935179ed0db152f94d31ef187c01a40f0fb42d6 /quantum/template/readme.md | |
| parent | 73d2a470eed73a1ba28520343bd1cfc81498d183 (diff) | |
| parent | 1585fc4b616cb28b8d4a418cd31c8ce0dd64f731 (diff) | |
| download | qmk_firmware-d6d0b7eadaa568853b21d74057db306a33b7a847.tar.gz | |
Merge https://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'quantum/template/readme.md')
| -rw-r--r-- | quantum/template/readme.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/quantum/template/readme.md b/quantum/template/readme.md index b2fb4dd98..b16f4cd76 100644 --- a/quantum/template/readme.md +++ b/quantum/template/readme.md @@ -3,7 +3,7 @@ ## Quantum MK Firmware -For the full Quantum feature list, see [the parent readme.md](/doc/readme.md). +For the full Quantum feature list, see [the parent readme](/). ## Building @@ -13,16 +13,16 @@ Depending on which keymap you would like to use, you will have to compile slight ### Default -To build with the default keymap, simply run `make`. +To build with the default keymap, simply run `make default`. ### Other Keymaps 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. -To build the firmware binary hex file with a keymap just do `make` with `keymap` option like: +To build the firmware binary hex file with a keymap just do `make` with a keymap like this: ``` -$ make keymap=[default|jack|<name>] +$ make [default|jack|<name>] ``` -Keymaps follow the format **__keymap.c__** and are stored in folders in the `keymaps` folder, eg `keymaps/my_keymap/`
\ No newline at end of file +Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. |