summaryrefslogtreecommitdiff
path: root/keyboard/planck/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboard/planck/README.md')
-rw-r--r--keyboard/planck/README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md
index b106fd8c4d..84d5000bb4 100644
--- a/keyboard/planck/README.md
+++ b/keyboard/planck/README.md
@@ -24,7 +24,13 @@ Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/a
Depending on which keymap you would like to use, you will have to compile slightly differently.
-**Extended Keymaps (default)**
+####Default
+To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows:
+```
+$ make
+```
+
+####**Extended Keymaps**
Extended keymaps need to be specified as follows:
```
@@ -32,7 +38,7 @@ $ make KEYMAP=[common|jack|<name>]
```
Applicable keymaps should follow the format **__extended\_keymap\_name.c__**
-**Common Keymaps**
+####**Common Keymaps**
Common keymaps need to be specified as follows:
```
@@ -40,12 +46,6 @@ $ make KEYMAP=[common|jack|<name>] COMMON=true
```
Applicable keymaps should follow the format **__keymap\_name.c__**
-
-To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows:
-```
-$ make
-```
-
## Keymap
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 `keymap_<name>.c` and see keymap document (you can find in top README.md) and existent keymap files.