summaryrefslogtreecommitdiffstats
path: root/keyboards/kinesis/keymaps/insertsnideremarks/readme.md
diff options
context:
space:
mode:
authorSalt-Peanuts <hajimeokuda@gmail.com>2018-04-20 17:53:35 +0200
committerDrashna Jaelre <drashna@live.com>2018-04-20 17:53:35 +0200
commitded93909446b633f3d296d3a360505330c1f9155 (patch)
treef1f8c8f5a656b17a6637515d9e033db9126f2acc /keyboards/kinesis/keymaps/insertsnideremarks/readme.md
parent3cab04dfa32e425bd114fb6c265ac8ea43cf127f (diff)
downloadqmk_firmware-ded93909446b633f3d296d3a360505330c1f9155.tar.gz
qmk_firmware-ded93909446b633f3d296d3a360505330c1f9155.tar.xz
Updated folder name; overdue updates to keymap and readme files (#2770)
* Updated info and fixed minor errors * Updated folder name; overdue updates to keymap and readme files Updated folder name; overdue updates to keymap and readme files
Diffstat (limited to 'keyboards/kinesis/keymaps/insertsnideremarks/readme.md')
-rw-r--r--keyboards/kinesis/keymaps/insertsnideremarks/readme.md249
1 files changed, 249 insertions, 0 deletions
diff --git a/keyboards/kinesis/keymaps/insertsnideremarks/readme.md b/keyboards/kinesis/keymaps/insertsnideremarks/readme.md
new file mode 100644
index 000000000..1920d4f9b
--- /dev/null
+++ b/keyboards/kinesis/keymaps/insertsnideremarks/readme.md
@@ -0,0 +1,249 @@
+# insertsnideremarks' Kinesis Keymap
+
+These layouts are derived from what I was using on my Kinesis Contoured keyboards with Hasu's TMK converters. With the move to QMK via Stapelberg replacement controller, I've cleaned up the layouts a bit while adding more functions and layers.
+
+There are minor changes in the base keywell layout of non-alpha keys (e.g., CapsLock is ESC/Ctl, arrow clusters on one side), while the thumb clusters deviate more from the default layout.
+
+Changes to the thumb clusters include:
+* The navigations keys moved to function layers.
+* The function of 2u keys have been reversed - I've always used space with my left thumb, and I find it more helpful to have access to Space and Enter while using my mouse/trackball.
+* Backspace have been duplicated on both clusters.
+* The 2u keys serve dual function as momentary layer switchers.
+
+I've largely left the function keys untouched, with the intension of not using them. They are neither easy to use nor reach due to their locations and size, and, prior to Advantage2, particularly terrible rubber domes were used for them. They have since updated the keys with Cherry ML switches on Advantage2, but did not resolve the issues of size or location. Additionally, leaving the function keys unused here makes it easier for me to adapt the keymaps to my other keyboards, most of which do not have physical function keys.
+
+I use Colemak Mod-DH Matrix as my default layout. There QWERTY and Colemak layouts as well.
+
+Additionally, I've added gaming/vanilla version of Colemak Mod-DH Matrix and QWERTY layouts. These layouts have no access to the Function or Numbers layers, thus no dual-role keys with layer access, and are mainly used for gaming.
+
+Persistent default layer has been enabled for Colemak Mod-DH Matrix, QWERTY, and Colemak. The gaming/vanilla Colemak Mod-DH Matrix and QWERTY can be set as default layer, but will not be persistent.
+
+## Future plans
+
+* Add status LEDs to the Stapelberg PCB (usually used for Caps Lock, Num Lock, and Scroll Lock). May configure it as layer indicator.
+* Add a speaker now that QMK supports additional pins for audio use.
+* Utilize the leftover spots on the key matrix, as well as unused pins on Teensy to run macropad and/or foot pedals.
+
+
+### Colemak Mod-DH Matrix
+ (Default layer, keys separated by /: tap for first, hold for second; uses Space Cadet Shifts)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Tab | Q | W | F | P | B | | J | L | U | Y | ; | \ |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ |Esc/Ctrl| A | R | S | T | G | | M | N | E | I | O | ' |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ |SC Shift| Z | X | C | D | V | | K | H | , | . | / |SC Shift|
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | Ins | ` | [ | ] | | Left | Down | Up | Right|
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ |Esc/Ctl| Hyper | | RAlt | RCtl |
+ ,-------|-------|-------| |-------+-------+-------.
+ | Space | Enter |App/Alt| | RGUI | Delete| Bspc |
+ | / | / |-------| |-------| / | / |
+ | Fn | Number| Bspc | | Tab |Number2| Fn2 |
+ `-----------------------' `-----------------------'
+
+
+### QWERTY
+ (Keys separated by /: tap for first, hold for second; uses Space Cadet Shifts)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Tab | Q | W | E | R | T | | Y | U | I | O | P | \ |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ |Esc/Ctrl| A | S | D | F | G | | H | J | K | L | ; | ' |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ |SC Shift| Z | X | C | V | B | | N | M | , | . | / |SC Shift|
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | Ins | ` | [ | ] | | Left | Down | Up | Right|
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ |Esc/Ctl| Hyper | | RAlt | RCtl |
+ ,-------|-------|-------| |-------+-------+-------.
+ | Space | Enter |App/Alt| | RGUI | Delete| Bspc |
+ | / | / |-------| |-------| / | / |
+ | Fn | Number| Bspc | | Tab |Number2| Fn2 |
+ `-----------------------' `-----------------------'
+
+
+### Colemak
+ (Keys separated by /: tap for first, hold for second; uses Space Cadet Shifts)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Tab | Q | W | F | P | G | | J | L | U | Y | ; | \ |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ |Esc/Ctrl| A | R | S | T | D | | H | N | E | I | O | ' |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ |SC Shift| Z | X | C | V | B | | K | M | , | . | / |SC Shift|
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | Ins | ` | [ | ] | | Left | Down | Up | Right|
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ |Esc/Ctl| Hyper | | RAlt | RCtl |
+ ,-------|-------|-------| |-------+-------+-------.
+ | Space | Enter |App/Alt| | RGUI | Delete| Bspc |
+ | / | / |-------| |-------| / | / |
+ | Fn | Number| Bspc | | Tab |Number2| Fn2 |
+ `-----------------------' `-----------------------'
+
+
+### Numbers & Symbols layer
+ (Multiple characters: single-tap for first, double-tap for second)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | | | | | | | | | | | | | | | | | | |
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | F12 | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F11 |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | 6 | 7 | 8 | 9 | 0 | | ^ | & | * | ( | ) | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | 1 | 2 | 3 | 4 | 5 | | ! | @ | # | $ | % | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | | . | / * | - _ | + = | | ` ~ | [ { | ] } | | | |
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | ( | ) | [ { | ] } | | | | | |
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ | | | | | |
+ ,-------|-------|-------| |-------+-------+-------.
+ | | | | | | | |
+ | | |-------| |-------| | |
+ | | | | | | | |
+ `-----------------------' `-----------------------'
+
+
+### Function layer
+ ,-----------------------------------------------------------------------------------------------------------.
+ | | | | | | | | | | | | | | | | | | |
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | F12 | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F11 |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | | | Up | | | | | | Up |Ctrl+Y| | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | |Ctrl+A| Left | Down | Right| | | PgUp | Right| Down | Left | Home | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | |Ctrl+Z|Ctrl+X|Ctrl+C|Ctrl+V| | | PgDn | Mute | Vol- | Vol+ | End | |
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | | | | | | Prev | Play | Next | Stop |
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ | | | | | |
+ ,-------|-------|-------| |-------+-------+-------.
+ | | | | | | | |
+ | | |-------| |-------| | |
+ | | | | |C+A+Tab| | |
+ `-----------------------' `-----------------------'
+
+
+### Numpad layer
+ (Left side duplicates layout from the Numbers layer, just with numpad output; right side layout close to PC numpad layout)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | | | | | | | | | | | | | | | | | | |
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | | NumLk| | | | | | Tab | NumLk| KP / | kP *| KP - | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | KP 6 | KP 7 | KP 8 | KP 9 | KP 0 | | | KP 7 | KP 8 | KP 9 | KP + | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | KP 1 | KP 2 | KP 3 | KP 4 | KP 5 | | | KP 4 | KP 5 | KP 6 | = | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | | KP . |KP/KP*| KP- _| KP+ =| | | KP 1 | KP 2 | KP 3 |KP Ent| |
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | ( | ) | [ { | ] } | | KP 0 | , | KP . |KP Ent|
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ | | | | | |
+ ,-------|-------|-------| |-------+-------+-------.
+ | | | | | | | |
+ | | |-------| |-------| | |
+ | | | | | | | |
+ `-----------------------' `-----------------------'
+
+
+### Colemak Mod-DH Matrix gaming/vanilla
+ (No access to Function or Numbers layers; mainly used for gaming; double-tap TD(ADJ) for one shot access to Adjust layer)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Tab | Q | W | F | P | B | | J | L | U | Y | ; | \ |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Ctrl | A | R | S | T | G | | M | N | E | I | O | ' |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Shift | Z | X | C | D | V | | K | H | , | . | / | Shift |
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | Ins | ` | [ | ] | | Left | Down | Up | Right|
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ |Esc/Ctl|TD(ADJ)| | RAlt | RCtl |
+ ,-------|-------|-------| |-------+-------+-------.
+ | | | LAlt | | RGUI | | |
+ | Space | Enter |-------| |-------| Delete| Bspc |
+ | | | Bspc | | Tab | | |
+ `-----------------------' `-----------------------'
+
+
+### QWERTY gaming/vanilla
+ (No access to Function or Numbers layers; mainly used for gaming; double-tap TD(ADJ) for one shot access to Adjust layer)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | ESC | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,-------------------------------------------.
+ | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Tab | Q | W | E | R | T | | Y | U | I | O | P | \ |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Ctrl | A | S | D | F | G | | H | J | K | L | ; | ' |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | Shift | Z | X | C | V | B | | N | M | , | . | / | Shift |
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | Ins | ` | [ | ] | | Left | Down | Up | Right|
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ |Esc/Ctl|TD(ADJ)| | RAlt | RCtl |
+ ,-------|-------|-------| |-------+-------+-------.
+ | | | LAlt | | RGUI | | |
+ | Space | Enter |-------| |-------| Delete| Bspc |
+ | | | Bspc | | Tab | | |
+ `-----------------------' `-----------------------'
+
+### Adjust layer
+ (Press Enter/Number + Delete/Number2 together under non-gaming/vanilla layers; Numpad is a toggle)
+ ,-----------------------------------------------------------------------------------------------------------.
+ | | | | | | | | | | | | | | | | | | |
+ `-----------------------------------------------------------------------------------------------------------'
+ ,-------------------------------------------. ,------------------------------------------
+ | |CModDH|Qwerty|Colmak|CMoDGM| QWGM | |Numpad| | | | | RESET |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | | | | | | | | | | | | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | | | | | | | | NKRO | | | | |
+ |--------+------+------+------+------+------| |------+------+------+------+------+--------|
+ | | | | | | | | | | | | | |
+ `--------+------+------+------+------+------' `------+------+------+------+------+--------'
+ | | | | | | | | | |
+ `---------------------------' `---------------------------'
+ ,---------------. ,---------------.
+ | | | | | |
+ ,-------|-------|-------| |-------+-------+-------.
+ | | | | | | | |
+ | | |-------| |-------| | |
+ | | | | | | | |
+ `-----------------------' `-----------------------'
+ \ No newline at end of file