Skip to content

Commit

Permalink
Remove redefinition of _______ in documentation example (qmk#3924)
Browse files Browse the repository at this point in the history
* Remove redefinition of `_______` in documentation example

* Slight rewording to include purpose of defintions

* Update include to newer macro
  • Loading branch information
AnthonyWharton authored and yamad committed Mar 21, 2019
1 parent 02215f0 commit 46e2911
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions docs/keymap.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,15 @@ There are 3 main sections of a `keymap.c` file you'll want to concern yourself w

At the top of the file you'll find this:

#include "clueboard.h"
#include QMK_KEYBOARD_H

// Helpful defines
#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))
#define _______ KC_TRNS

/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* You can use _______ in place for KC_TRNS (transparent) *
* Or you can use XXXXXXX for KC_NO (NOOP) *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */

// Each layer gets a name for readability.
// The underscores don't mean anything - you can
Expand All @@ -105,7 +109,9 @@ At the top of the file you'll find this:
#define _FL 1
#define _CL 2

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.
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.

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.

### Layers and Keymaps

Expand Down

0 comments on commit 46e2911

Please sign in to comment.