summaryrefslogtreecommitdiff
path: root/keyboard/planck/README.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2016-03-30 00:45:48 -0400
committerJack Humbert <jack.humb@gmail.com>2016-03-30 00:45:48 -0400
commite7377dc24b4aaf97f9c48ef7db78b7b6cbabe748 (patch)
tree7774668076bb8c8d2331028bb540510c078e60be /keyboard/planck/README.md
parentb8ac5095708b5023f5e3e375b22534f8b395741f (diff)
parent4a676746a6d8c9b47956f863ead335e995677c53 (diff)
Merge branch 'master' of https://github.com/jackhumbert/tmk_keyboard
Diffstat (limited to 'keyboard/planck/README.md')
-rw-r--r--keyboard/planck/README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md
index 3ba0cc1527..d9a1e3beee 100644
--- a/keyboard/planck/README.md
+++ b/keyboard/planck/README.md
@@ -16,13 +16,13 @@ Depending on which keymap you would like to use, you will have to compile slight
To build with the default keymap, simply run `make`.
### 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` and see keymap document (you can find in top README.md) and existent keymap files.
+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:
```
$ make KEYMAP=[default|jack|<name>]
```
-Keymaps follow the format **__<name\>.c__** and are stored in the `keymaps` folder.
+Keymaps follow the format **__\<name\>.c__** and are stored in the `keymaps` folder.
### Notable forks (which some of the keymap files are from)
- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)