diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2017-03-31 18:28:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-03-31 18:28:14 -0400 |
| commit | ec35fea26420dc7d11dfa464f912566e5a5424c1 (patch) | |
| tree | e15a10c89c3442c1afaf2d636c09a3680b0d35d3 | |
| parent | 2b4efaba53164fc1487df3147ac7ded8bece4272 (diff) | |
| parent | caab4d7e4576c10e45becea4a8fc69a7c9c064e0 (diff) | |
| download | qmk_firmware-ec35fea26420dc7d11dfa464f912566e5a5424c1.tar.gz qmk_firmware-ec35fea26420dc7d11dfa464f912566e5a5424c1.zip | |
Merge pull request #1190 from osamuaoki/master
Fix typo
| -rw-r--r-- | doc/keymap.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/keymap.md b/doc/keymap.md index bc7809905..3ea138ea8 100644 --- a/doc/keymap.md +++ b/doc/keymap.md | |||
| @@ -6,12 +6,12 @@ QMK is based on TMK. Understanding the essential changes made should help you | |||
| 6 | 6 | ||
| 7 | ## TMK vs. QMK | 7 | ## TMK vs. QMK |
| 8 | 8 | ||
| 9 | | Firmware |TMK |QMK | | 9 | | Firmware |TMK |QMK | |
| 10 | |-------------------------------------------------|-----------------------|-------------------------| | 10 | |---------------------------|-----------------------|-------------------------| |
| 11 | | Maintainer |hasu |Jack Humbert et al. | | 11 | | Maintainer |hasu |Jack Humbert et al. | |
| 12 | | Build path customization | `TMK_DIR = ...` | `include .../Makefile` | | 12 | | Build path customization | `TMK_DIR = ...` | `include .../Makefile` | |
| 13 | | `keymaps` data | 3D array of `uint8_t` holding **keycode** | 3D array of `uint16_t` holding **action code** | | 13 | | `keymaps` data | 3D array of `uint8_t` holding **keycode** | 3D array of `uint16_t` holding **action code** | |
| 14 | | `fn_actions` data | 1D array of `uint16_t` holding **action code** | 3D array of `uint16_t` holding **action code** | | 14 | | `fn_actions` data | 1D array of `uint16_t` holding **action code** | 1D array of `uint16_t` holding **action code** | |
| 15 | 15 | ||
| 16 | Since QMK is based on TMK and uses major portion of TMK code as is, understanding the essential changes made should help you understand the code. | 16 | Since QMK is based on TMK and uses major portion of TMK code as is, understanding the essential changes made should help you understand the code. |
| 17 | 17 | ||
| @@ -45,7 +45,7 @@ Keymap layer has its state in two 32 bit parameters: | |||
| 45 | * **`default_layer_state`** indicates a base keymap layer(0-31) which is always valid and to be referred. | 45 | * **`default_layer_state`** indicates a base keymap layer(0-31) which is always valid and to be referred. |
| 46 | * **`layer_state`** () has current on/off status of the layer on its each bit. | 46 | * **`layer_state`** () has current on/off status of the layer on its each bit. |
| 47 | 47 | ||
| 48 | Keymap has its state in two parameter**`default_layer`** indicates a base keymap layer(0-31) which is always valid and to be referred, **`keymap_stat`** is 16bit variable which has current on/off status of layers on its each bit. | 48 | Keymap has its state in two parameter **`default_layer`** indicates a base keymap layer(0-31) which is always valid and to be referred, **`keymap_stat`** is 16bit variable which has current on/off status of layers on its each bit. |
| 49 | Keymap layer '0' is usually `default_layer` and which is the only valid layer and other layers is initially off after boot up firmware, though, you can configured them in `config.h`. | 49 | Keymap layer '0' is usually `default_layer` and which is the only valid layer and other layers is initially off after boot up firmware, though, you can configured them in `config.h`. |
| 50 | To change `default_layer` will be useful when you switch key layout completely, say you want Colmak instead of Qwerty. | 50 | To change `default_layer` will be useful when you switch key layout completely, say you want Colmak instead of Qwerty. |
| 51 | 51 | ||