summaryrefslogtreecommitdiffstats
path: root/keyboards/kinesis/keymaps/insertsnideremarks/readme.md
blob: b3c573b62592b4551e37268d68b73f66347583ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
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.  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 are QWERTY and regular 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 |      |      |      |        |
	|--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
	|        |      |      |      |      |      |                   |      |      |      |      |      |        |
	`--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
	         |      |      |      |      |                                 |      |      |      |      |
	         `---------------------------'                                 `---------------------------'
	                            ,---------------.                   ,---------------.
	                            |       |       |                   |       |       |
	                    ,-------|-------|-------|                   |-------+-------+-------.
	                    |       |       |       |                   |       |       |       |
	                    |       |       |-------|                   |-------|       |       |
	                    |       |       |       |                   |       |       |       |
	                    `-----------------------'                   `-----------------------'