summaryrefslogtreecommitdiffstats
path: root/docs/feature_leader_key.md
diff options
context:
space:
mode:
authorAlexander Kagno <cwre@protonmail.com>2018-12-15 08:29:24 -0700
committerDrashna Jaelre <drashna@live.com>2018-12-15 07:29:24 -0800
commit3ec4a00bfc090fc440480336e3273b459074aa18 (patch)
tree95cd72fb059d961a3868a9dcf67f2fb1fb6ba7e2 /docs/feature_leader_key.md
parent72bd17f2902c82ef84b9134433facb21ad696fbb (diff)
Per Key Leader Timing Option (#4026)
* leader changes to enable per key timing option * Changes requested to docs for @drashna * Changes requested by @drashna
Diffstat (limited to 'docs/feature_leader_key.md')
-rw-r--r--docs/feature_leader_key.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/feature_leader_key.md b/docs/feature_leader_key.md
index 92aebd463d..9b49e0fd96 100644
--- a/docs/feature_leader_key.md
+++ b/docs/feature_leader_key.md
@@ -47,3 +47,26 @@ To add support for Leader Key you simply need to add a single line to your keyma
```
LEADER_ENABLE = yes
```
+
+## Per Key Timing on Leader keys
+
+Rather than relying on an incredibly high timeout for long leader key strings or those of us without 200wpm typing skills, we can enable per key timing to ensure that each key pressed provides us with more time to finish our stroke. This is incredibly helpful with leader key emulation of tap dance (read: multiple taps of the same key like C, C, C).
+
+In order to enable this, place this in your `config.h`:
+```
+#define LEADER_PER_KEY_TIMING
+```
+
+After this, it's recommended that you lower your `LEADER_TIMEOUT` to something less that 300ms.
+
+```
+#define LEADER_TIMEOUT 250
+```
+
+Now, something like this won't seem impossible to do without a 1000MS leader key timeout:
+
+```
+SEQ_THREE_KEYS(KC_C, KC_C, KC_C) {
+ SEND_STRING("Per key timing is great!!!");
+}
+```