diff options
| author | Anthony Wharton <a.wharton.2015@bristol.ac.uk> | 2018-09-20 00:18:15 +0100 |
|---|---|---|
| committer | Drashna Jaelre <drashna@live.com> | 2018-09-19 16:18:15 -0700 |
| commit | 334e2629df4adb44b0ac0dff3363a6daebc072e7 (patch) | |
| tree | c1668aff535f28f19a65a78305e3d64cc95eb376 | |
| parent | 77433b1a3140411b8b8f1b0389827c38384fc5fe (diff) | |
| download | qmk_firmware-334e2629df4adb44b0ac0dff3363a6daebc072e7.tar.gz qmk_firmware-334e2629df4adb44b0ac0dff3363a6daebc072e7.zip | |
Remove redefinition of `_______` in documentation example (#3924)
* Remove redefinition of `_______` in documentation example
* Slight rewording to include purpose of defintions
* Update include to newer macro
| -rw-r--r-- | docs/keymap.md | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/docs/keymap.md b/docs/keymap.md index b28d21a21..382a0e911 100644 --- a/docs/keymap.md +++ b/docs/keymap.md | |||
| @@ -89,11 +89,15 @@ There are 3 main sections of a `keymap.c` file you'll want to concern yourself w | |||
| 89 | 89 | ||
| 90 | At the top of the file you'll find this: | 90 | At the top of the file you'll find this: |
| 91 | 91 | ||
| 92 | #include "clueboard.h" | 92 | #include QMK_KEYBOARD_H |
| 93 | 93 | ||
| 94 | // Helpful defines | 94 | // Helpful defines |
| 95 | #define GRAVE_MODS (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)|MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)|MOD_BIT(KC_LALT)|MOD_BIT(KC_RALT)) | 95 | #define GRAVE_MODS (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)|MOD_BIT(KC_LGUI)|MOD_BIT(KC_RGUI)|MOD_BIT(KC_LALT)|MOD_BIT(KC_RALT)) |
| 96 | #define _______ KC_TRNS | 96 | |
| 97 | /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * | ||
| 98 | * You can use _______ in place for KC_TRNS (transparent) * | ||
| 99 | * Or you can use XXXXXXX for KC_NO (NOOP) * | ||
| 100 | * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | ||
| 97 | 101 | ||
| 98 | // Each layer gets a name for readability. | 102 | // Each layer gets a name for readability. |
| 99 | // The underscores don't mean anything - you can | 103 | // The underscores don't mean anything - you can |
| @@ -105,7 +109,9 @@ At the top of the file you'll find this: | |||
| 105 | #define _FL 1 | 109 | #define _FL 1 |
| 106 | #define _CL 2 | 110 | #define _CL 2 |
| 107 | 111 | ||
| 108 | These are some handy definitions we can use when building our keymap and our custom function. The `GRAVE_MODS` definition will be used later in our custom function. The `_______` define makes it easier to see what keys a layer is overriding, while the `_BL`, `_FL`, and `_CL` defines make it easier to refer to each of our layers. | 112 | These are some handy definitions we can use when building our keymap and our custom function. The `GRAVE_MODS` definition will be used later in our custom function, and the following `_BL`, `_FL`, and `_CL` defines make it easier to refer to each of our layers. |
| 113 | |||
| 114 | Note: You may also find some older keymap files may also have a define(s) for `_______` and/or `XXXXXXX`. These can be used in place for `KC_TRNS` and `KC_NO` respectively, making it easier to see what keys a layer is overriding. These definitions are now unecessary, as they are included by default. | ||
| 109 | 115 | ||
| 110 | ### Layers and Keymaps | 116 | ### Layers and Keymaps |
| 111 | 117 | ||
