diff options
| author |  Stephen Christie <undersampled@live.com> | 2016-09-19 18:05:58 -0400 |
|---|---|---|
| committer | Stephen Christie <undersampled@live.com> | 2016-09-19 18:05:58 -0400 |
| commit | 57a6828a7a73d7b7c3dd9693e04d6873e2e3d1c2 (patch) | |
| tree | bdabbdbdd9fd6de500728721d1865058468871e3 /keyboards/planck/readme.md | |
| parent | bf2b260429dbc015d49d005065a37441c8f15753 (diff) | |
| parent | 5f9c2f63ffb2c58db73e67442134be58bfe2c129 (diff) | |
| download | qmk_firmware-57a6828a7a73d7b7c3dd9693e04d6873e2e3d1c2.tar.gz | |
Merge branch 'master' of http://github.com/jackhumbert/qmk_firmware
Diffstat (limited to 'keyboards/planck/readme.md')
| -rw-r--r-- | keyboards/planck/readme.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/keyboards/planck/readme.md b/keyboards/planck/readme.md index f89fdeb93..4b24a690e 100644 --- a/keyboards/planck/readme.md +++ b/keyboards/planck/readme.md @@ -13,15 +13,17 @@ Download or clone the whole firmware and navigate to the keyboards/planck folder Depending on which keymap you would like to use, you will have to compile slightly differently. ### 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 file named `<name>.c` in the keymaps folder, and see keymap document (you can find in top readme.md) and existent 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 **__\<name\>.c__** and are stored in the `keymaps` folder. ### Notable forks (which some of the keymap files are from) |