diff options
| author | Noah Andrews <NoahAndrews@users.noreply.github.com> | 2016-03-29 21:53:36 -0400 |
|---|---|---|
| committer | Noah Andrews <NoahAndrews@users.noreply.github.com> | 2016-03-29 21:53:36 -0400 |
| commit | 95fba250ef2029ccdedb34500c5d1e96f6d065cf (patch) | |
| tree | abec71f825ce412d13e057bc1bd89018cf3bb8f7 /keyboard/planck/README.md | |
| parent | e28334017c94c6928dd7e82436cec171f0243747 (diff) | |
Updated several keyboard folders to use new keymap naming scheme
Diffstat (limited to 'keyboard/planck/README.md')
| -rw-r--r-- | keyboard/planck/README.md | 4 |
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) |