diff options
| author | Joshua T <joshua@sonofone.net> | 2016-09-01 07:40:46 -0500 |
|---|---|---|
| committer | Joshua T <joshua@sonofone.net> | 2016-09-01 07:40:46 -0500 |
| commit | 5520b0022fc6cd3dff805eb31ed4bb7e4385ee2a (patch) | |
| tree | 0346d24fd7a8905486a687c68084af25022c4312 /keyboards/planck/readme.md | |
| parent | b0c3d596816c178ccd94738a3866a08b71027d0d (diff) | |
| parent | e28d151a8a1d458f3c18897c6095decc17b0c3a1 (diff) | |
Merge remote-tracking branch 'upstream/master'
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 f89fdeb931..4b24a690e0 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) |