mirrors/opensteno_qmk
1
0
Fork 0
mirror of https://github.com/openstenoproject/qmk synced 2024-11-12 11:34:38 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source 
Updated formatting again...
This commit is contained in:
Reed Swiernik 2015-04-24 18:35:57 -04:00 committed by Reed Swiernik
parent c85f68d9cd
commit 835207193a
1 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
keyboard/planck/README.md
View file

@ -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. 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: 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__** Applicable keymaps should follow the format **__extended\_keymap\_name.c__**
**Common Keymaps** ####**Common Keymaps**
Common keymaps need to be specified as follows: 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__** 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 ## 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. 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.