diff options
| author | coderkun <olli@coderkun.de> | 2016-10-02 10:04:29 +0200 |
|---|---|---|
| committer | coderkun <olli@coderkun.de> | 2016-10-02 10:04:29 +0200 |
| commit | 8655677584483e46d9b45873aa50ec6e860486dd (patch) | |
| tree | 3f1037d47607fd40be82fe9169795978f8f3551f /keyboards/planck/readme.md | |
| parent | a10e100bd5e8bad73e1b04f54639a4cec36e4b9e (diff) | |
| parent | 35e6870e5c8943c044187256e01c96ef400ca067 (diff) | |
| download | qmk_firmware-8655677584483e46d9b45873aa50ec6e860486dd.tar.gz qmk_firmware-8655677584483e46d9b45873aa50ec6e860486dd.zip | |
Merge branch 'master' into coderkun_neo2
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) |