diff options
Diffstat (limited to 'keyboards/planck/keymaps/smt/readme.md')
| -rw-r--r-- | keyboards/planck/keymaps/smt/readme.md | 103 |
1 files changed, 103 insertions, 0 deletions
diff --git a/keyboards/planck/keymaps/smt/readme.md b/keyboards/planck/keymaps/smt/readme.md new file mode 100644 index 000000000..0e955a574 --- /dev/null +++ b/keyboards/planck/keymaps/smt/readme.md | |||
| @@ -0,0 +1,103 @@ | |||
| 1 | # smt's Planck keymap | ||
| 2 | |||
| 3 | This keymap is primarily based on the default Planck keymap. | ||
| 4 | |||
| 5 | Notable differences from the default are: | ||
| 6 | |||
| 7 | 1. **Dvorak by default** | ||
| 8 | |||
| 9 | I happen to type in Dvorak, and prefer that layer to be the default on my keyboard. This is easy enough to switch around with Qwerty, Colemak, or whatever. | ||
| 10 | |||
| 11 | 2. **Right Shift** | ||
| 12 | |||
| 13 | I use both the left and right shift keys when I type. When I want to modify a key with shift, I hold shift with the hand opposite the one typing the key. In the default keymap, Enter is where shift would be on a standard keyboard layout. Oh, muscle memory. | ||
| 14 | |||
| 15 | Thankfully, QMK supports [mod-tap](https://github.com/jackhumbert/qmk_firmware/wiki#fun-with-modifier-keys) keys, and this allows me to set the Enter key to send a modifier (MOD_LSFT) when held, and KC_ENT when tapped. Awesome! | ||
| 16 | |||
| 17 | 3. Escape | ||
| 18 | |||
| 19 | I am experimenting with using Left Shift as a mod-tap key for Escape, similar to how I use the Enter key. It's set up like this on my Minivan, so in the interest of consistency... | ||
| 20 | |||
| 21 | 4. Backtick | ||
| 22 | |||
| 23 | I don't currently have LEDs on any of my keyboards, and even if I did, I don't think I would want their controls on a base layer. | ||
| 24 | |||
| 25 | So, why use backtick in the lower left corner? I use it as my tmux prefix key, so I need to type it more frequently than most people. Putting it on the base layer works well for me. | ||
| 26 | |||
| 27 | ## Dvorak (default) | ||
| 28 | |||
| 29 | ``` | ||
| 30 | ,-----------------------------------------------------------------------------------. | ||
| 31 | | Tab | " | , | . | P | Y | F | G | C | R | L | Bksp | | ||
| 32 | |------+------+------+------+------+-------------+------+------+------+------+------| | ||
| 33 | | Esc | A | O | E | U | I | D | H | T | N | S | - | | ||
| 34 | |------+------+------+------+------+------|------+------+------+------+------+------| | ||
| 35 | | Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter | | ||
| 36 | |------+------+------+------+------+------+------+------+------+------+------+------| | ||
| 37 | | ` | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | ||
| 38 | `-----------------------------------------------------------------------------------' | ||
| 39 | ``` | ||
| 40 | |||
| 41 | ## Qwerty (same as default) | ||
| 42 | |||
| 43 | ``` | ||
| 44 | ,-----------------------------------------------------------------------------------. | ||
| 45 | | Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp | | ||
| 46 | |------+------+------+------+------+-------------+------+------+------+------+------| | ||
| 47 | | Esc | A | S | D | F | G | H | J | K | L | ; | " | | ||
| 48 | |------+------+------+------+------+------|------+------+------+------+------+------| | ||
| 49 | | Shift| Z | X | C | V | B | N | M | , | . | / |Enter | | ||
| 50 | |------+------+------+------+------+------+------+------+------+------+------+------| | ||
| 51 | | ` | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right | | ||
| 52 | `-----------------------------------------------------------------------------------' | ||
| 53 | ``` | ||
| 54 | |||
| 55 | ## Lower | ||
| 56 | |||
| 57 | This is where I put the number row, a numpad cluster, function keys, and some light navigation via Home/End/PageUp/PageDn. Like the "Raise" layer, the top row is redundant to help with Planck compatibility. | ||
| 58 | |||
| 59 | ``` | ||
| 60 | ,-----------------------------------------------------------------------------------. | ||
| 61 | | ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del | | ||
| 62 | |------+------+------+------+------+-------------+------+------+------+------+------| | ||
| 63 | | | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | Home |PageUp| | ||
| 64 | |------+------+------+------+------+------|------+------+------+------+------+------| | ||
| 65 | | | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | End |PageDn| | ||
| 66 | |------+------+------+------+------+------+------+------+------+------+------+------| | ||
| 67 | | | | | | | | | Next | Vol- | Vol+ | Play | | ||
| 68 | `-----------------------------------------------------------------------------------' | ||
| 69 | ``` | ||
| 70 | |||
| 71 | ## Raise | ||
| 72 | |||
| 73 | As a developer, it makes the most sense for me to group all the commonly-used symbols that don't fit on the main layer. In particular, having the dual-column of parens-braces-brackets really helps a lot. | ||
| 74 | |||
| 75 | I haven't completely filled this layer, which leaves room for future mappings and macros. | ||
| 76 | |||
| 77 | ``` | ||
| 78 | ,-----------------------------------------------------------------------------------. | ||
| 79 | | ~ | ! | @ | # | $ | % | ^ | & | * | ( | ) | Del | | ||
| 80 | |------+------+------+------+------+-------------+------+------+------+------+------| | ||
| 81 | | | | | | | | _ | ? | + | { | } | | | | ||
| 82 | |------+------+------+------+------+------|------+------+------+------+------+------| | ||
| 83 | | | | | | | | - | / | = | [ | ] | \ | | ||
| 84 | |------+------+------+------+------+------+------+------+------+------+------+------| | ||
| 85 | | | | | | | | | Next | Vol- | Vol+ | Play | | ||
| 86 | `-----------------------------------------------------------------------------------' | ||
| 87 | ``` | ||
| 88 | |||
| 89 | ## Adjust (Lower + Raise) | ||
| 90 | |||
| 91 | Utility layer. This is where I'd switch to Qwerty, or ~~fool around with~~ adjust the audio/music settings. | ||
| 92 | |||
| 93 | ``` | ||
| 94 | ,-----------------------------------------------------------------------------------. | ||
| 95 | | | Reset| | | | | | | | | | Del | | ||
| 96 | |------+------+------+------+------+-------------+------+------+------+------+------| | ||
| 97 | | | | |Aud on|AudOff|AGnorm|AGswap|Dvorak|Qwerty| | | | | ||
| 98 | |------+------+------+------+------+------|------+------+------+------+------+------| | ||
| 99 | | |Voice-|Voice+|Mus on|MusOff|MidiOn|MidOff| | | | | | | ||
| 100 | |------+------+------+------+------+------+------+------+------+------+------+------| | ||
| 101 | | | | | | | | | | | | | | ||
| 102 | `-----------------------------------------------------------------------------------' | ||
| 103 | ``` | ||
