diff options
| author |  Jack Humbert <jack.humb@gmail.com> | 2016-08-27 13:49:42 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2016-08-27 13:49:42 -0400 |
| commit | 36b6a96596e6cbca879d5304a586e279c15b04a9 (patch) | |
| tree | 7fdd6b9084f06e5126516ac61756120e1ce1eb63 /keyboards/planck/readme.md | |
| parent | 2c8f6557e6994d3fe4fa2038f6cb4a4e51caf3a9 (diff) | |
| parent | 265df7d5da5ead27bef3d00fce7d0f2bf133e9cc (diff) | |
| download | qmk_firmware-36b6a96596e6cbca879d5304a586e279c15b04a9.tar.gz | |
Merge pull request #666 from fredizzimo/makefile_overhaul
Makefile overhaul
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) |