summaryrefslogtreecommitdiff
path: root/keyboards/planck
diff options
context:
space:
mode:
authorStephen Tudor <smt@smt.io>2017-03-08 23:16:58 -0500
committerStephen Tudor <smt@smt.io>2017-03-08 23:16:58 -0500
commit8d4bc714e4e69dd89b0ef7f1bad60e6ca6c0f791 (patch)
tree087b039579ec6f9bf44d974429f17f6a2b847f42 /keyboards/planck
parent88e862e4728343fab4ed7e8dc44ae5594b702955 (diff)
downloadqmk_firmware-8d4bc714e4e69dd89b0ef7f1bad60e6ca6c0f791.tar.gz
qmk_firmware-8d4bc714e4e69dd89b0ef7f1bad60e6ca6c0f791.zip
Update smt keymap READMEs
Diffstat (limited to 'keyboards/planck')
-rw-r--r--keyboards/planck/keymaps/smt/keymap.c4
-rw-r--r--keyboards/planck/keymaps/smt/readme.md79
2 files changed, 52 insertions, 31 deletions
diff --git a/keyboards/planck/keymaps/smt/keymap.c b/keyboards/planck/keymaps/smt/keymap.c
index 2e1c355477..708f699da9 100644
--- a/keyboards/planck/keymaps/smt/keymap.c
+++ b/keyboards/planck/keymaps/smt/keymap.c
@@ -97,9 +97,9 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
* ,-----------------------------------------------------------------------------------.
* | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
* |------+------+------+------+------+-------------+------+------+------+------+------|
- * | $ | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | Home |PageUp|
+ * | $ | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | | |
* |------+------+------+------+------+------|------+------+------+------+------+------|
- * | | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | End |PageDn|
+ * | | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | | |
* |------+------+------+------+------+------+------+------+------+------+------+------|
* | | | | | | | | Next | Vol- | Vol+ | Play |
* `-----------------------------------------------------------------------------------'
diff --git a/keyboards/planck/keymaps/smt/readme.md b/keyboards/planck/keymaps/smt/readme.md
index 0e955a5742..dc7c9cf9f1 100644
--- a/keyboards/planck/keymaps/smt/readme.md
+++ b/keyboards/planck/keymaps/smt/readme.md
@@ -4,49 +4,70 @@ This keymap is primarily based on the default Planck keymap.
Notable differences from the default are:
-1. **Dvorak by default**
+- **[Mod-Tap](https://github.com/jackhumbert/qmk_firmware/wiki#fun-with-modifier-keys) keys**
- 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.
+ - `Esc/Ctrl`
-2. **Right Shift**
+ 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...
- 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.
+ - `Enter/Shift`
- 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!
+ 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.
-3. Escape
+ - `Tab/Hyper` (Super+Ctrl+Shift+Alt)
- 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...
+ It's great to be able to use Tab as a custom modifier key. I tend to use [Hyper](http://brettterpstra.com/2012/12/08/a-useful-caps-lock-key/) commands for various OS-specific operations depending on what machine I'm working on.
-4. Backtick
+ - `Backtick/Meh` (Ctrl+Shift+Alt)
- 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.
+ 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. The "Meh" mapping is just a less-cool "Hyper"; the same, just without Super.
- 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.
+- **Swapped responsibilities of "lower" and "raise" layers**
-## Dvorak (default)
+ I prefer to use symbols via the "raise" layer, and numbers via the "lower" layer.
+
+- **Removed Plover layer**
+
+ I don't intend to use stenography anytime soon, so Plover just didn't have a place in my keymap.
+
+
+## Qwerty
```
,-----------------------------------------------------------------------------------.
-| Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
+| Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
|------+------+------+------+------+-------------+------+------+------+------+------|
-| Esc | A | O | E | U | I | D | H | T | N | S | - |
+| Esc | A | S | D | F | G | H | J | K | L | ; | " |
|------+------+------+------+------+------|------+------+------+------+------+------|
-| Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
+| Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
-| ` | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
+| ` | Ctrl | Alt | GUI |Lower |Space |Space |Raise | Left | Down | Up |Right |
`-----------------------------------------------------------------------------------'
```
-## Qwerty (same as default)
+## Colemak
```
,-----------------------------------------------------------------------------------.
-| Tab | Q | W | E | R | T | Y | U | I | O | P | Bksp |
+| Tab | Q | W | F | P | G | J | L | U | Y | ; | Bksp |
|------+------+------+------+------+-------------+------+------+------+------+------|
-| Esc | A | S | D | F | G | H | J | K | L | ; | " |
+| Esc | A | R | S | T | D | H | N | E | I | O | " |
|------+------+------+------+------+------|------+------+------+------+------+------|
-| Shift| Z | X | C | V | B | N | M | , | . | / |Enter |
+| Shift| Z | X | C | V | B | K | M | , | . | / |Enter |
+|------+------+------+------+------+------+------+------+------+------+------+------|
+| ` | Ctrl | Alt | GUI |Lower |Space |Space |Raise | Left | Down | Up |Right |
+`-----------------------------------------------------------------------------------'
+```
+
+## Dvorak
+
+```
+,-----------------------------------------------------------------------------------.
+| Tab | " | , | . | P | Y | F | G | C | R | L | Bksp |
+|------+------+------+------+------+-------------+------+------+------+------+------|
+| Esc | A | O | E | U | I | D | H | T | N | S | - |
+|------+------+------+------+------+------|------+------+------+------+------+------|
+| Shift| ; | Q | J | K | X | B | M | W | V | Z |Enter |
|------+------+------+------+------+------+------+------+------+------+------+------|
| ` | Ctrl | Alt | GUI |Lower | Space |Raise | Left | Down | Up |Right |
`-----------------------------------------------------------------------------------'
@@ -54,15 +75,15 @@ Notable differences from the default are:
## Lower
-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.
+This is where I put the number row, a numpad cluster, function keys, and media controls.
```
,-----------------------------------------------------------------------------------.
-| ` | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
+| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | Del |
|------+------+------+------+------+-------------+------+------+------+------+------|
-| | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | Home |PageUp|
+| $ | F1 | F2 | F3 | F4 | F5 | F6 | 4 | 5 | 6 | | |
|------+------+------+------+------+------|------+------+------+------+------+------|
-| | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | End |PageDn|
+| | F7 | F8 | F9 | F10 | F11 | F12 | 1 | 2 | 3 | | |
|------+------+------+------+------+------+------+------+------+------+------+------|
| | | | | | | | Next | Vol- | Vol+ | Play |
`-----------------------------------------------------------------------------------'
@@ -70,7 +91,7 @@ This is where I put the number row, a numpad cluster, function keys, and some li
## Raise
-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.
+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. I've also added cursorkeys to correspond to the arrows.
I haven't completely filled this layer, which leaves room for future mappings and macros.
@@ -82,21 +103,21 @@ I haven't completely filled this layer, which leaves room for future mappings an
|------+------+------+------+------+------|------+------+------+------+------+------|
| | | | | | | - | / | = | [ | ] | \ |
|------+------+------+------+------+------+------+------+------+------+------+------|
-| | | | | | | | Next | Vol- | Vol+ | Play |
+| | | | | | | | | Home |PageDn|PageUp| End |
`-----------------------------------------------------------------------------------'
```
## Adjust (Lower + Raise)
-Utility layer. This is where I'd switch to Qwerty, or ~~fool around with~~ adjust the audio/music settings.
+Utility layer. This is where I'd switch between Qwerty and Dvorak, ~~fool around with~~ adjust the audio/music settings, or put the Planck into bootloader mode.
```
,-----------------------------------------------------------------------------------.
-| | Reset| | | | | | | | | | Del |
+| | Reset| | | | | | | | | | Reset|
|------+------+------+------+------+-------------+------+------+------+------+------|
-| | | |Aud on|AudOff|AGnorm|AGswap|Dvorak|Qwerty| | | |
+| | | |Aud on|Audoff|AGnorm|AGswap|Qwerty|Colemk|Dvorak| | |
|------+------+------+------+------+------|------+------+------+------+------+------|
-| |Voice-|Voice+|Mus on|MusOff|MidiOn|MidOff| | | | | |
+| |Voice-|Voice+|Mus on|Musoff|MIDIon|MIDIof| | | | | |
|------+------+------+------+------+------+------+------+------+------+------+------|
| | | | | | | | | | | |
`-----------------------------------------------------------------------------------'