diff options
author | Jack Humbert <jack.humb@gmail.com> | 2017-06-10 14:58:24 -0400 |
---|---|---|
committer | Jack Humbert <jack.humb@gmail.com> | 2017-06-10 14:58:24 -0400 |
commit | ca01d94005f67ec4fa9528353481faa622d949ae (patch) | |
tree | dd6d59d065492e3bb8192263a8a7e7cc0709c48f /docs/keymap_examples.md | |
parent | 558db0e03f0f3993e2b7fb5cc3f285393da0a4c3 (diff) | |
download | qmk_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.md | 37 |
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! | ||
2 | https://github.com/tmk/tmk_keyboard/issues/265 | ||
3 | |||
4 | --- | ||
5 | |||
6 | ## Reverse-shifted for numbers | ||
7 | With 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 | ||
12 | Keymap code on Alps64 | ||
13 | https://github.com/thisisshi/tmk_keyboard/blob/15fe63e8d181a8a95988dcc71929f0024df55caa/keyboard/alps64/keymap_pure.c | ||
14 | |||
15 | and guide. | ||
16 | https://github.com/thisisshi/tmk_keyboard/blob/77ac0805ade565fb23657e3644c920ada71edccf/keyboard/alps64/Guide.md | ||
17 | |||
18 | ## Prevent stuck modifiers | ||
19 | |||
20 | Consider the following scenario: | ||
21 | |||
22 | 1. Layer 0 has a key defined as Shift. | ||
23 | 2. The same key is defined on layer 1 as the letter A. | ||
24 | 3. User presses Shift. | ||
25 | 4. User switches to layer 1 for whatever reason. | ||
26 | 5. User releases Shift, or rather the letter A. | ||
27 | 6. User switches back to layer 0. | ||
28 | |||
29 | Shift was actually never released and is still considered pressed. | ||
30 | |||
31 | If such situation bothers you add this to your `config.h`: | ||
32 | |||
33 | #define PREVENT_STUCK_MODIFIERS | ||
34 | |||
35 | This option uses 5 bytes of memory per every 8 keys on the keyboard | ||
36 | rounded up (5 bits per key). For example on Planck (48 keys) it uses | ||
37 | (48/8)\*5 = 30 bytes. | ||