diff options
| author | Damien <Dbroqua@users.noreply.github.com> | 2016-08-29 22:33:50 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-08-29 22:33:50 +0200 |
| commit | af24ea558a65fea549bd9f57a9704b904972d2f7 (patch) | |
| tree | 50cd382df7dac58057c958f62732174cf0dfe920 /keyboards/planck/readme.md | |
| parent | 8e058135e2905d6a2ec281d29e5a93cb808bd8a5 (diff) | |
| parent | 6d1e916851daa7bcbd8ef31b6fbc73cb369ef1f0 (diff) | |
Merge pull request #3 from jackhumbert/master
Merge from jackhumbert
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) |