summaryrefslogtreecommitdiffstats
path: root/docs/feature_leader_key.md
diff options
context:
space:
mode:
authorJoe Wasson <jwasson+github@gmail.com>2018-09-17 19:48:02 +0200
committerJack Humbert <jack.humb@gmail.com>2018-09-17 19:48:02 +0200
commit743449472e58651ec8111e6f70811103fb0a28bd (patch)
treebf8391fd9ba42ec08fa42fc867b20810cbe27d4f /docs/feature_leader_key.md
parentb65e2143751fd7c1721a6690597f523137c7c484 (diff)
downloadqmk_firmware-743449472e58651ec8111e6f70811103fb0a28bd.tar.gz
qmk_firmware-743449472e58651ec8111e6f70811103fb0a28bd.tar.xz
Make `PREVENT_STUCK_MODIFIERS` the default (#3107)
* Remove chording as it is not documented, not used, and needs work. * Make Leader Key an optional feature. * Switch from `PREVENT_STUCK_MODIFIERS` to `STRICT_LAYER_RELEASE` * Remove `#define PREVENT_STUCK_MODIFIERS` from keymaps.
Diffstat (limited to 'docs/feature_leader_key.md')
-rw-r--r--docs/feature_leader_key.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/feature_leader_key.md b/docs/feature_leader_key.md
index 46633b287..0c3f4a133 100644
--- a/docs/feature_leader_key.md
+++ b/docs/feature_leader_key.md
@@ -39,3 +39,11 @@ void matrix_scan_user(void) {
As you can see, you have a few function. You can use `SEQ_ONE_KEY` for single-key sequences (Leader followed by just one key), and `SEQ_TWO_KEYS`, `SEQ_THREE_KEYS` up to `SEQ_FIVE_KEYS` for longer sequences.
Each of these accepts one or more keycodes as arguments. This is an important point: You can use keycodes from **any layer on your keyboard**. That layer would need to be active for the leader macro to fire, obviously.
+
+## Adding Leader Key Support in the `rules.mk`
+
+To add support for Leader Key you simply need to add a single line to your keymap's `rules.mk`:
+
+```
+LEADER_ENABLE = yes
+```