aboutsummaryrefslogtreecommitdiff
path: root/keyboards/planck/readme.md
diff options
context:
space:
mode:
authorFred Sundvik <fsundvik@gmail.com>2016-08-20 03:22:16 +0300
committerFred Sundvik <fsundvik@gmail.com>2016-08-20 03:56:48 +0300
commitda226e61261e0c11e678d2086c00b2a45726083e (patch)
tree3157d1db1b8f35782e25533e62a0b46bcb42fc99 /keyboards/planck/readme.md
parentb4c75569b0bc2f3ba9a7766ab64ff504fad3836e (diff)
downloadqmk_firmware-da226e61261e0c11e678d2086c00b2a45726083e.tar.gz
qmk_firmware-da226e61261e0c11e678d2086c00b2a45726083e.zip
Update keyboard readme files with new makefile instructions
Diffstat (limited to 'keyboards/planck/readme.md')
-rw-r--r--keyboards/planck/readme.md8
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
13Depending on which keymap you would like to use, you will have to compile slightly differently. 13Depending on which keymap you would like to use, you will have to compile slightly differently.
14 14
15### Default 15### Default
16To build with the default keymap, simply run `make`. 16To build with the default keymap, simply run `make default`.
17 17
18### Other Keymaps 18### Other Keymaps
19Several 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. 19Several 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.
20 20
21To build the firmware binary hex file with a keymap just do `make` with `KEYMAP` option like: 21To build the firmware binary hex file with a keymap just do `make` with a keymap like this:
22
22``` 23```
23$ make KEYMAP=[default|jack|<name>] 24$ make [default|jack|<name>]
24``` 25```
26
25Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder. 27Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
26 28
27### Notable forks (which some of the keymap files are from) 29### Notable forks (which some of the keymap files are from)