summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorZach Burchill <burchill@users.noreply.github.com>2017-11-09 22:18:31 +0100
committerJack Humbert <jack.humb@gmail.com>2017-11-09 22:18:31 +0100
commite236f1eba19f357e524300959e0127bfe2813de1 (patch)
tree53436d4b02cdd877c167e440ada5c52994981ccc
parent847ade44fc648f124801dfffc9dcd69442db6a91 (diff)
downloadqmk_firmware-e236f1eba19f357e524300959e0127bfe2813de1.tar.gz
qmk_firmware-e236f1eba19f357e524300959e0127bfe2813de1.tar.xz
Fixed some grammar and typos on the docs (#1989)
* fixed grammar and references * fixed typo
-rw-r--r--docs/keymap.md12
1 files changed, 5 insertions, 7 deletions
diff --git a/docs/keymap.md b/docs/keymap.md
index 2961e0e8d..62130d700 100644
--- a/docs/keymap.md
+++ b/docs/keymap.md
@@ -28,14 +28,12 @@ Respective layers can be validated simultaneously. Layers are indexed with 0 to
Sometimes, the action code stored in keymap may be referred as keycode in some documents due to the TMK history.
### Keymap layer status
-Keymap layer has its state in two 32 bit parameters:
+The state of the Keymap layer is determined by two 32 bit parameters:
-* **`default_layer_state`** indicates a base keymap layer(0-31) which is always valid and to be referred.
-* **`layer_state`** () has current on/off status of the layer on its each bit.
+* **`default_layer_state`** indicates a base keymap layer (0-31) which is always valid and to be referred (the default layer).
+* **`layer_state`** has current on/off status of each layer in its bits.
-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.
-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`.
-To change `default_layer` will be useful when you switch key layout completely, say you want Colemak instead of Qwerty.
+Keymap layer '0' is usually `default_layer`, wither other layers initially off after booting up the firmware, although this can configured differently in `config.h`. It is useful to change `default_layer` when you completely switch a key layout, for example, if you want to switch to Colemak instead of Qwerty.
Initial state of Keymap Change base layout
----------------------- ------------------
@@ -52,7 +50,7 @@ To change `default_layer` will be useful when you switch key layout completely,
`--- default_layer = 0 `--- default_layer = 1
layer_state = 0x00000001 layer_state = 0x00000002
-On the other hand, you shall change `layer_state` to overlay base layer with some layers for feature such as navigation keys, function key(F1-F12), media keys or special actions.
+On the other hand, you can change `layer_state` to overlay the base layer with other layers for features such as navigation keys, function keys (F1-F12), media keys, and/or special actions.
Overlay feature layer
--------------------- bit|status