summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorReed Swiernik <reed.swiernik@gmail.com>2015-04-24 18:35:57 -0400
committerReed Swiernik <rswiernik@csh.rit.edu>2015-04-25 12:18:11 -0400
commit835207193a8d5c366d783c8953d4aeaee5ee094a (patch)
treea44587107187d8b5a43cd53d484c0056dc2672aa
parentc85f68d9cd2963e0a00dfe05fea75b824d5f4fcc (diff)
Update README.md
Updated formatting again...
-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.