]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - Keymap.md
Created Unit testing (markdown)
[qmk_firmware.git] / Keymap.md
index bc135dd6f7c8274a2b84c277229fb5c0284b5fee..9f519d5e6aecbbcf953728068b9f4f12dd20a4fb 100644 (file)
--- a/Keymap.md
+++ b/Keymap.md
@@ -4,11 +4,13 @@ QMK keymaps are defined inside a C source file. The data structure is an array o
 
 ## 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). There are 3 main sections of a `keymap.c` file you'll want to concern yourself with:
+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.
 
-* The Definitions
-* The Layer/Keymap Datastructure
-* Custom Functions, if any
+There are 3 main sections of a `keymap.c` file you'll want to concern yourself with:
+
+* [The Definitions](#definitions)
+* [The Layer/Keymap Datastructure](#layers-and-keymaps)
+* [Custom Functions](#custom-functions), if any
 
 ### Definitions
 
@@ -82,7 +84,7 @@ At the bottom of the file we've defined a single custom function. This function
 
 #### `fn_actions[]`
 
-We define the `fn_actions[]` array to point to custom functions. `F(N)` in a keymap will call element N of that array. In the Clueboard's case that definition looks like this:
+We define the `fn_actions[]` array to point to custom functions. `F(N)` in a keymap will call element N of that array. For the Clueboard's that looks like this:
 
     const uint16_t PROGMEM fn_actions[] = {
       [0] = ACTION_FUNCTION(0),  // Calls action_function()