aboutsummaryrefslogtreecommitdiff
path: root/docs/keymap_examples.md
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-06-10 14:58:24 -0400
committerJack Humbert <jack.humb@gmail.com>2017-06-10 14:58:24 -0400
commitca01d94005f67ec4fa9528353481faa622d949ae (patch)
treedd6d59d065492e3bb8192263a8a7e7cc0709c48f /docs/keymap_examples.md
parent558db0e03f0f3993e2b7fb5cc3f285393da0a4c3 (diff)
downloadqmk_firmware-ca01d94005f67ec4fa9528353481faa622d949ae.tar.gz
qmk_firmware-ca01d94005f67ec4fa9528353481faa622d949ae.zip
convert docs to lowercase and underscores
Diffstat (limited to 'docs/keymap_examples.md')
-rw-r--r--docs/keymap_examples.md37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/keymap_examples.md b/docs/keymap_examples.md
new file mode 100644
index 000000000..094011931
--- /dev/null
+++ b/docs/keymap_examples.md
@@ -0,0 +1,37 @@
1# Share your keymap idea here!
2https://github.com/tmk/tmk_keyboard/issues/265
3
4---
5
6## Reverse-shifted for numbers
7With pressing Shift and '1' key you get **1** while with just '1' key you get **!**.
8- https://geekhack.org/index.php?topic=41989.msg1959718#msg1959718
9
10
11## KBT Pure layout
12Keymap code on Alps64
13https://github.com/thisisshi/tmk_keyboard/blob/15fe63e8d181a8a95988dcc71929f0024df55caa/keyboard/alps64/keymap_pure.c
14
15and guide.
16https://github.com/thisisshi/tmk_keyboard/blob/77ac0805ade565fb23657e3644c920ada71edccf/keyboard/alps64/Guide.md
17
18## Prevent stuck modifiers
19
20Consider the following scenario:
21
221. Layer 0 has a key defined as Shift.
232. The same key is defined on layer 1 as the letter A.
243. User presses Shift.
254. User switches to layer 1 for whatever reason.
265. User releases Shift, or rather the letter A.
276. User switches back to layer 0.
28
29Shift was actually never released and is still considered pressed.
30
31If such situation bothers you add this to your `config.h`:
32
33 #define PREVENT_STUCK_MODIFIERS
34
35This option uses 5 bytes of memory per every 8 keys on the keyboard
36rounded up (5 bits per key). For example on Planck (48 keys) it uses
37(48/8)\*5 = 30 bytes.