X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=docs%2Fkeymap.md;h=2961e0e8d6afb75fbd0ed0fe921c1776b355bace;hb=4e41beeaa6b5facb3757c966e2bfb661669bfc21;hp=53b17f401962daac1e08b3993bb8f71d91ebd17a;hpb=ea3df7466aa29312b3e781f29532e10fa8a08a1f;p=qmk_firmware.git diff --git a/docs/keymap.md b/docs/keymap.md index 53b17f401..2961e0e8d 100644 --- a/docs/keymap.md +++ b/docs/keymap.md @@ -35,7 +35,7 @@ Keymap layer has its state in two 32 bit parameters: 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 Colmak instead of Qwerty. +To change `default_layer` will be useful when you switch key layout completely, say you want Colemak instead of Qwerty. Initial state of Keymap Change base layout ----------------------- ------------------ @@ -79,7 +79,7 @@ Key with `KC_TRANS` (`KC_TRNS` and `_______` are the alias) doesn't has its own ## Anatomy Of A `keymap.c` -For this example we will walk through the [default Clueboard keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard/keymaps/default/keymap.c). You'll find it helpful to open that file in another browser window so you can look at everything in context. +For this example we will walk through the [default Clueboard 66% keymap](https://github.com/qmk/qmk_firmware/blob/master/keyboards/clueboard_66/keymaps/default/keymap.c). You'll find it helpful to open that file in another browser window so you can look at everything in context. There are 3 main sections of a `keymap.c` file you'll want to concern yourself with: @@ -215,8 +215,7 @@ To actually handle the keypress event we define an `action_function()`. This fun This should have given you a basic overview for creating your own keymap. For more details see the following resources: -* https://github.com/qmk/qmk_firmware/wiki/Keycodes -* https://github.com/qmk/qmk_firmware/wiki/FAQ-Keymap -* https://github.com/qmk/qmk_firmware/wiki/Keymap-examples +* [Keycodes](keycodes.md) +* [Keymap FAQ](faq_keymap.md) -We are actively working to improve these docs. If you have suggestions for how they could be made better please [file an issue](https://github.com/qmk/qmk_firmware/issues/new)! \ No newline at end of file +We are actively working to improve these docs. If you have suggestions for how they could be made better please [file an issue](https://github.com/qmk/qmk_firmware/issues/new)!