]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/kinesis/keymaps/insertsnideremarks/readme.md
[Keyboard] Add QMK configurator JSON for Alice PCB (#6397)
[qmk_firmware.git] / keyboards / kinesis / keymaps / insertsnideremarks / readme.md
1 ## I've changed my folder name to match my GitHub username.  Please see https://github.com/qmk/qmk_firmware/tree/master/keyboards/kinesis/keymaps/tuesdayjohn for my current keymap files.
2
3 ## insertsnideremarks' Kinesis Keymap
4
5 These layouts are derived from what I was using on my Kinesis Contoured keyboards with Hasu's USB-USB 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.
6
7 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.
8
9 Changes to the thumb clusters include: 
10 * The navigations keys moved to function layers.
11 * 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.
12 * Backspace have been duplicated on both clusters.
13 * The 2u keys serve dual function as momentary layer switchers.
14
15 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 the rubber domes used were terrible.  They have since replaced 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.
16
17 I use Colemak as my default layout.  I've included QWERTY here as well.
18
19 Additionally, I've added gaming/vanilla version of Colemak and QWERTY layouts.  These layouts have limited access to the Function or Numbers/Symbols layers, and are mainly used for gaming.
20
21 Persistent default layer has been enabled for Colemak and QWERTY.  The gaming/vanilla Colemak and QWERTY can be set as default layer, but will not be persistent.
22
23 ## Future plans
24
25 * Add status LEDs to the Stapelberg PCB (usually used for Caps Lock, Num Lock, and Scroll Lock) to use as layer indicators.
26 * Add a speaker now that QMK supports additional pins for audio use.
27 * Utilize the leftover spots on the key matrix, as well as unused pins on Teensy++ 2.0 to run macropad and/or foot pedals.
28
29
30 ### Colemak
31     (Default layer; keys separated by /: tap for first, hold for second; uses Space Cadet Shifts)
32     ,-----------------------------------------------------------------------------------------------------------.
33     | ESC |  F1 |  F2 |  F3 |  F4 |  F5 |  F6 |  F7 |  F8 |  F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
34     `-----------------------------------------------------------------------------------------------------------'
35     ,-------------------------------------------.                   ,-------------------------------------------.
36     |    =   |   1  |   2  |   3  |   4  |   5  |                   |   6  |   7  |   8  |   9  |   0  |   -    |
37     |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
38     |   Tab  |   Q  |   W  |   F  |   P  |   G  |                   |   J  |   L  |   U  |   Y  |   ;  |   \    |
39     |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
40     |Esc/Ctrl|   A  |   R  |   S  |   T  |   D  |                   |   H  |   N  |   E  |   I  |   O  |   '    |
41     |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
42     |SC Shift|   Z  |   X  |   C  |   V  |   B  |                   |   K  |   M  |   ,  |   .  |   /  |SC Shift|
43     `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
44              |  Ins |   `  |   [  |   ]  |                                 | Left | Down |  Up  | Right|
45                  `---------------------------'                                 `---------------------------'
46                                     ,---------------.                   ,---------------.
47                                     |Esc/Ctl| Hyper |                   |  RAlt |  RCtl |
48                             ,-------|-------|-------|                   |-------+-------+-------.
49                             | Space | Enter |App/Alt|                   |  RGUI | Delete|  Bspc |
50                             |   /   |   /   |-------|                   |-------|   /   |   /   |
51                             |  Fn   | Number|  Bspc |                   | Enter |Number2|  Fn2  |
52                             `-----------------------'                   `-----------------------' 
53         
54         
55 ### QWERTY
56         (Keys separated by /: tap for first, hold for second; uses Space Cadet Shifts)
57         ,-----------------------------------------------------------------------------------------------------------.
58         | ESC |  F1 |  F2 |  F3 |  F4 |  F5 |  F6 |  F7 |  F8 |  F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
59         `-----------------------------------------------------------------------------------------------------------'
60         ,-------------------------------------------.                   ,-------------------------------------------.
61         |    =   |   1  |   2  |   3  |   4  |   5  |                   |   6  |   7  |   8  |   9  |   0  |   -    |
62         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
63         |   Tab  |   Q  |   W  |   E  |   R  |   T  |                   |   Y  |   U  |   I  |   O  |   P  |   \    |
64         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
65         |Esc/Ctrl|   A  |   S  |   D  |   F  |   G  |                   |   H  |   J  |   K  |   L  |   ;  |   '    |
66         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
67         |SC Shift|   Z  |   X  |   C  |   V  |   B  |                   |   N  |   M  |   ,  |   .  |   /  |SC Shift|
68         `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
69                  |  Ins |   `  |   [  |   ]  |                                 | Left | Down |  Up  | Right|
70                  `---------------------------'                                 `---------------------------'
71                                     ,---------------.                   ,---------------.
72                                     |Esc/Ctl| Hyper |                   |  RAlt |  RCtl |
73                             ,-------|-------|-------|                   |-------+-------+-------.
74                             | Space | Enter |App/Alt|                   |  RGUI | Delete|  Bspc |
75                             |   /   |   /   |-------|                   |-------|   /   |   /   |
76                             |  Fn   | Number|  Bspc |                   | Enter |Number2|  Fn2  |
77                             `-----------------------'                   `-----------------------' 
78         
79
80 ### Numbers & Symbols layer
81         (Multiple characters: single-tap for first, double-tap for second)
82         ,-----------------------------------------------------------------------------------------------------------.
83         |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |
84         `-----------------------------------------------------------------------------------------------------------'
85         ,-------------------------------------------.                   ,-------------------------------------------.
86         |   F12  |  F1  |  F2  |  F3  |  F4  |  F5  |                   |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
87         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
88         |        |   6  |   7  |   8  |   9  |   0  |                   |   ^  |   &  |   *  |   (  |   )  |        |
89         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
90         |        |   1  |   2  |   3  |   4  |   5  |                   |   !  |   @  |   #  |   $  |   %  |        |
91         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
92         |        |      |   .  |  / * |  - _ |  + = |                   |  ` ~ |  [ { |  ] } |      |      |        |
93         `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
94                  |   (  |   )  |  [ { |  ] } |                                 |      |      |      |      |
95                  `---------------------------'                                 `---------------------------'
96                                     ,---------------.                   ,---------------.
97                                     |       |       |                   |       |       |
98                             ,-------|-------|-------|                   |-------+-------+-------.
99                             |       |       |       |                   |       |       |       |
100                             |       |       |-------|                   |-------|       |       |
101                             |       |       |       |                   |       |       |       |
102                             `-----------------------'                   `-----------------------' 
103         
104
105 ### Function layer
106         ,-----------------------------------------------------------------------------------------------------------.
107         |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |
108         `-----------------------------------------------------------------------------------------------------------'
109         ,-------------------------------------------.                   ,-------------------------------------------.
110         |   F12  |  F1  |  F2  |  F3  |  F4  |  F5  |                   |  F6  |  F7  |  F8  |  F9  |  F10 |   F11  |
111         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
112         |        |      |      |  Up  |      |      |                   |      |      |  Up  |Ctrl+Y|      |        |
113         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
114         |        |Ctrl+A| Left | Down | Right|C+A+Tb|                   | PgUp | Right| Down | Left | Home |        |
115         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
116         |        |Ctrl+Z|Ctrl+X|Ctrl+C|Ctrl+V| Bspc |                   | PgDn | Mute | Vol- | Vol+ |  End |        |
117         `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
118                  |      |      |      |      |                                 | Prev | Play | Next | Stop |
119                  `---------------------------'                                 `---------------------------'
120                                     ,---------------.                   ,---------------.
121                                     |       |       |                   |       |       |
122                             ,-------|-------|-------|                   |-------+-------+-------.
123                             |       |       |       |                   |       |       |       |
124                             |       |       |-------|                   |-------|       |       |
125                             |       |       |       |                   |       |       |       |
126                             `-----------------------'                   `-----------------------' 
127         
128
129 ### Numpad layer
130         (Left side duplicates layout from the Numbers layer, just with numpad output; right side layout close to PC numpad layout)
131         ,-----------------------------------------------------------------------------------------------------------.
132         |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |
133         `-----------------------------------------------------------------------------------------------------------'
134         ,-------------------------------------------.                   ,-------------------------------------------.
135         |        | NumLk|      |      |      |      |                   |  Tab | NumLk| KP / | KP * | KP - |        |
136         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
137         |        | KP 6 | KP 7 | KP 8 | KP 9 | KP 0 |                   |      | KP 7 | KP 8 | KP 9 | KP + |        |
138         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
139         |        | KP 1 | KP 2 | KP 3 | KP 4 | KP 5 |                   |      | KP 4 | KP 5 | KP 6 |  =   |        |
140         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
141         |        |      | KP . |KP/KP*| KP- _| KP+ =|                   |      | KP 1 | KP 2 | KP 3 |KP Ent|        |
142         `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
143                  |   (  |   )  |  [ { |  ] } |                                 | KP 0 |  ,   | KP . |KP Ent|
144                  `---------------------------'                                 `---------------------------'
145                                     ,---------------.                   ,---------------.
146                                     |       |       |                   |       |       |
147                             ,-------|-------|-------|                   |-------+-------+-------.
148                             |       |       |       |                   |       |       |       |
149                             |       |       |-------|                   |-------|       |       |
150                             |       |       |       |                   |       |       |       |
151                             `-----------------------'                   `-----------------------' 
152         
153
154 ### Colemak gaming/vanilla
155     (Limited access to Function or Numbers layers; mainly used for gaming; Ent/NS + Delete/Numbers2 to access Adjust layer)
156         ,-----------------------------------------------------------------------------------------------------------.
157         | ESC |  F1 |  F2 |  F3 |  F4 |  F5 |  F6 |  F7 |  F8 |  F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
158         `-----------------------------------------------------------------------------------------------------------'
159         ,-------------------------------------------.                   ,-------------------------------------------.
160         |    =   |   1  |   2  |   3  |   4  |   5  |                   |   6  |   7  |   8  |   9  |   0  |   -    |
161         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
162         |   Tab  |   Q  |   W  |   F  |   P  |   G  |                   |   J  |   L  |   U  |   Y  |   ;  |   \    |
163         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
164         |  LCtrl |   A  |   R  |   S  |   T  |   D  |                   |   H  |   N  |   E  |   I  |   O  |   '    |
165         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
166         |  Shift |   Z  |   X  |   C  |   V  |   B  |                   |   K  |   M  |   ,  |   .  |   /  |  Shift |
167         `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
168                  |  Ins |   `  |   [  |   ]  |                                 | Left | Down |  Up  | Right|
169                  `---------------------------'                                 `---------------------------'
170                                     ,---------------.                   ,---------------.
171                                     |  Esc  |       |                   |  RAlt |  RCtl |
172                             ,-------|-------|-------|                   |-------+-------+-------.
173                             |       |       |  LAlt |                   |  RGUI | Delete|  Bspc |
174                             | Space | Enter |-------|                   |-------|   /   |   /   |
175                             |       |       |  Bspc |                   | Ent/NS|Number2|  Fn2  |
176                             `-----------------------'                   `-----------------------' 
177         
178
179 ### QWERTY gaming/vanilla
180     (Limited access to Function or Numbers layers; mainly used for gaming; Ent/NS + Delete/Numbers2 to access Adjust layer)
181         ,-----------------------------------------------------------------------------------------------------------.
182         | ESC |  F1 |  F2 |  F3 |  F4 |  F5 |  F6 |  F7 |  F8 |  F9 | F10 | F11 | F12 | PScr| SLck| Paus|Numpd|Adjst|
183         `-----------------------------------------------------------------------------------------------------------'
184         ,-------------------------------------------.                   ,-------------------------------------------.
185         |    =   |   1  |   2  |   3  |   4  |   5  |                   |   6  |   7  |   8  |   9  |   0  |   -    |
186         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
187         |   Tab  |   Q  |   W  |   E  |   R  |   T  |                   |   Y  |   U  |   I  |   O  |   P  |   \    |
188         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
189         |  LCtrl |   A  |   S  |   D  |   F  |   G  |                   |   H  |   J  |   K  |   L  |   ;  |   '    |
190         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
191         |  Shift |   Z  |   X  |   C  |   V  |   B  |                   |   N  |   M  |   ,  |   .  |   /  |  Shift |
192         `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
193                  |  Ins |   `  |   [  |   ]  |                                 | Left | Down |  Up  | Right|
194                  `---------------------------'                                 `---------------------------'
195                                     ,---------------.                   ,---------------.
196                                     |  Esc  |       |                   |  RAlt |  RCtl |
197                             ,-------|-------|-------|                   |-------+-------+-------.
198                             |       |       |  LAlt |                   |  RGUI | Delete|  Bspc |
199                             | Space | Enter |-------|                   |-------|   /   |   /   |
200                             |       |       |  Bspc |                   | Ent/NS|Number2|  Fn2  |
201                             `-----------------------'                   `-----------------------' 
202         
203 ### Adjust layer
204         (Press Enter/Number + Delete/Number2 under non-gaming/vanilla layers or press & hold Adjust key on function row; Numpad is a toggle)
205         ,-----------------------------------------------------------------------------------------------------------.
206         |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |     |
207         `-----------------------------------------------------------------------------------------------------------'
208         ,-------------------------------------------.                   ,-------------------------------------------.
209         |        |Colmak|Qwerty|      |ClmkGM| QWGM |                   |Numpad|      |      |      |      | RESET  |
210         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
211         |        |      |      |      |      |      |                   |      |      |      |      |      |        |
212         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
213         |        |      |      |      |      |      |                   |      | NKRO |      |      |      |        |
214         |--------+------+------+------+------+------|                   |------+------+------+------+------+--------|
215         |        |      |      |      |      |      |                   |      |      |      |      |      |        |
216         `--------+------+------+------+------+------'                   `------+------+------+------+------+--------'
217                  |      |      |      |      |                                 |      |      |      |      |
218                  `---------------------------'                                 `---------------------------'
219                                     ,---------------.                   ,---------------.
220                                     |       |       |                   |       |       |
221                             ,-------|-------|-------|                   |-------+-------+-------.
222                             |       |       |       |                   |       |       |       |
223                             |       |       |-------|                   |-------|       |       |
224                             |       |       |       |                   |       |       |       |
225                             `-----------------------'                   `-----------------------' 
226