summaryrefslogtreecommitdiff
path: root/keyboard/planck/README.md
diff options
context:
space:
mode:
authorAlex Johnstone2016-04-05 07:44:37 -0700
committerAlex Johnstone2016-04-05 07:44:37 -0700
commit1facc53a26294df7fb2a42f8f3d025176b8c384a (patch)
tree98eebfa4beb49524c1345c2dd9e93d1fb8aa445a /keyboard/planck/README.md
parent48899673af8b82638d601455f405f03db165bd57 (diff)
parent931b0a79fc071498c229b0051be0ebadd934a549 (diff)
Merge pull request #5 from jackhumbert/master
Sync with upstream
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 3ba0cc152..d9a1e3bee 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)