aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Keymap-examples.md
diff options
context:
space:
mode:
authorNick Choi <nikchi@users.noreply.github.com>2017-05-30 14:17:48 -0400
committerGitHub <noreply@github.com>2017-05-30 14:17:48 -0400
commit2c9f846608cbf91ce936071372634194745994d0 (patch)
tree7fc260baa3bca7ba748117e07fca8aaa186943dd /docs/Keymap-examples.md
parent5393bc6f4eee3d3cb83997e5b03d8e5a5cea85d8 (diff)
parentcb791cf6cdbcd9fd1291f36f6b1a6840753db97f (diff)
downloadfirmware-2c9f846608cbf91ce936071372634194745994d0.tar.gz
firmware-2c9f846608cbf91ce936071372634194745994d0.tar.bz2
firmware-2c9f846608cbf91ce936071372634194745994d0.zip
Merge pull request #2 from qmk/master
pull in new qmk changes
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 @@
+# Share your keymap idea here!
+https://github.com/tmk/tmk_keyboard/issues/265
+
+---
+
+## Reverse-shifted for numbers
+With pressing Shift and '1' key you get **1** while with just '1' key you get **!**.
+- https://geekhack.org/index.php?topic=41989.msg1959718#msg1959718
+
+
+## KBT Pure layout
+Keymap code on Alps64
+https://github.com/thisisshi/tmk_keyboard/blob/15fe63e8d181a8a95988dcc71929f0024df55caa/keyboard/alps64/keymap_pure.c
+
+and guide.
+https://github.com/thisisshi/tmk_keyboard/blob/77ac0805ade565fb23657e3644c920ada71edccf/keyboard/alps64/Guide.md
+
+## Prevent stuck modifiers
+
+Consider the following scenario:
+
+1. Layer 0 has a key defined as Shift.
+2. The same key is defined on layer 1 as the letter A.
+3. User presses Shift.
+4. User switches to layer 1 for whatever reason.
+5. User releases Shift, or rather the letter A.
+6. User switches back to layer 0.
+
+Shift was actually never released and is still considered pressed.
+
+If such situation bothers you add this to your `config.h`:
+
+ #define PREVENT_STUCK_MODIFIERS
+
+This option uses 5 bytes of memory per every 8 keys on the keyboard
+rounded up (5 bits per key). For example on Planck (48 keys) it uses
+(48/8)\*5 = 30 bytes.