masq
/
qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #694 from fredizzimo/keyboard_template 

Fix the keyboard template with new make syntax
This commit is contained in:
Jack Humbert 2016-08-27 17:07:49 -04:00 committed by GitHub
parent 4fd5ac8326 1f5838a286
commit a1b289c99a
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
quantum/template/readme.md
View File

@ -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/`
Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.