mirrors/qmk_firmware
1
0
Fork 1
mirror of https://github.com/qmk/qmk_firmware synced 2024-11-11 22:44:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source 
Switched around more readme stuff
This commit is contained in:
Reed Swiernik 2015-04-24 18:49:49 -04:00 committed by Reed Swiernik
parent d0391d9ed7
commit 79f70b20d9
1 changed files with 8 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
keyboard/planck/README.md
View file

@ -25,33 +25,29 @@ 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.
####Default ####Default
To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows: To build with the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows:
``` ```
$ make $ 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.
####**Extended Keymaps** ####**Extended Keymaps**
Extended keymaps need to be specified as follows: To build the firmware binary hex file with an extended keymap just do `make` with `KEYMAP` option like:
``` ```
$ make KEYMAP=[common|jack|<name>] $ make KEYMAP=[common|jack|<name>]
``` ```
Applicable keymaps should follow the format **__extended\_keymap\_<name>.c__** _The only applicable keymaps will work with this option._ Extended keymaps follow the format **__extended\_keymap\_\<name\>.c__**
####**Common Keymaps** ####**Common Keymaps**
Common keymaps need to be specified as follows: Building with a common keymap is as simple as adding the COMMON option. Note that only
``` ```
$ make KEYMAP=[common|jack|<name>] COMMON=true $ make KEYMAP=[common|jack|<name>] COMMON=true
``` ```
Applicable keymaps should follow the format **__keymap\_<name>.c__** _The only applicable keymaps will work with this option._ Common keymaps follow the format **__keymap\_\<name\>.c__**
## 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.
To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like:
$ make KEYMAP=[<name>]
## Notable TMK forks (which some of the keymap files are from) ## Notable TMK forks (which some of the keymap files are from)
- [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck)