aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJack Humbert <jack.humb@gmail.com>2017-04-26 19:22:36 -0400
committerGitHub <noreply@github.com>2017-04-26 19:22:36 -0400
commit26bbfd78125224abdbd2e4ccf3aa3df1b5fc4968 (patch)
treecccdc512fed02293ffd0bfb962ec14d8a8664e7f
parent5a809ac178b4c580d1b50a3e2b58071c62028e15 (diff)
parent196740a0bb9e63b5293eaaf11ac66f24be8404a6 (diff)
downloadqmk_firmware-26bbfd78125224abdbd2e4ccf3aa3df1b5fc4968.tar.gz
qmk_firmware-26bbfd78125224abdbd2e4ccf3aa3df1b5fc4968.zip
Merge pull request #1259 from laelath/master
Added a proper README to the lae3 keymap
-rw-r--r--keyboards/planck/keymaps/lae3/keymap.c20
-rw-r--r--keyboards/planck/keymaps/lae3/readme.md112
2 files changed, 121 insertions, 11 deletions
diff --git a/keyboards/planck/keymaps/lae3/keymap.c b/keyboards/planck/keymaps/lae3/keymap.c
index 81f94ccd6..4127a3ae1 100644
--- a/keyboards/planck/keymaps/lae3/keymap.c
+++ b/keyboards/planck/keymaps/lae3/keymap.c
@@ -52,11 +52,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
52 /* Qwerty 52 /* Qwerty
53 * ,-----------------------------------------------------------------------------------. 53 * ,-----------------------------------------------------------------------------------.
54 * | Esc | Q | W | E | R | T | Y | U | I | O | P | Bksp | 54 * | Esc | Q | W | E | R | T | Y | U | I | O | P | Bksp |
55 * |------+------+------+------+------+-------------+------+------+------+------+------| 55 * |------+------+------+------+------+------+------+------+------+------+------+------|
56 * | Tab | A | S | D | F | G | H | J | K | L | ; |Enter | 56 * | Tab | A | S | D | F | G | H | J | K | L | ; |Enter |
57 * |------+------+------+------+------+------|------+------+------+------+------+------|
58 * |Shift | Z | X | C | V | B | N | M | , | . | / |Shift |
59 * |------+------+------+------+------+------+------+------+------+------+------+------| 57 * |------+------+------+------+------+------+------+------+------+------+------+------|
58 * |Shift | Z | X | C | V | B | N | M | , | . | / |Shift |
59 * |------+------+------+------+------+-------------+------+------+------+------+------|
60 * | Ctrl | GUI | Alt | Move |Lower | Space |Raise | Move | Alt | GUI | Ctrl | 60 * | Ctrl | GUI | Alt | Move |Lower | Space |Raise | Move | Alt | GUI | Ctrl |
61 * `-----------------------------------------------------------------------------------' 61 * `-----------------------------------------------------------------------------------'
62 */ 62 */
@@ -93,7 +93,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
93 * |------+------+------+------+------+------+------+------+------+------+------+------| 93 * |------+------+------+------+------+------+------+------+------+------+------+------|
94 * | | | | | | | | 3 | 2 | 1 | - | | 94 * | | | | | | | | 3 | 2 | 1 | - | |
95 * |------+------+------+------+------+-------------+------+------+------+------+------| 95 * |------+------+------+------+------+-------------+------+------+------+------+------|
96 * | | | | | | | | 0 | = | + | | 96 * | | | | | | | | 0 | . | + | |
97 * `-----------------------------------------------------------------------------------' 97 * `-----------------------------------------------------------------------------------'
98 */ 98 */
99 [_NUMPAD] = { 99 [_NUMPAD] = {
@@ -124,11 +124,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
124 /* Lower 124 /* Lower
125 * ,-----------------------------------------------------------------------------------. 125 * ,-----------------------------------------------------------------------------------.
126 * | ` | 1 | 2 | 3 | 4 | 5 | - | = | Del | End | PgDn | | 126 * | ` | 1 | 2 | 3 | 4 | 5 | - | = | Del | End | PgDn | |
127 * |------+------+------+------+------+-------------+------+------+------+------+------| 127 * |------+------+------+------+------+------+------+------+------+------+------+------|
128 * | Caps | 6 | 7 | 8 | 9 | 0 | [ | ] | \ | ' | | | 128 * | Caps | 6 | 7 | 8 | 9 | 0 | [ | ] | \ | ' | | |
129 * |------+------+------+------+------+------|------+------+------+------+------+------|
130 * | | F1 | F2 | F3 | F4 | | | F5 | F6 | F7 | F8 | |
131 * |------+------+------+------+------+------+------+------+------+------+------+------| 129 * |------+------+------+------+------+------+------+------+------+------+------+------|
130 * | | F1 | F2 | F3 | F4 | | | F5 | F6 | F7 | F8 | |
131 * |------+------+------+------+------+-------------+------+------+------+------+------|
132 * | | | | | | | | | | | | 132 * | | | | | | | | | | | |
133 * `-----------------------------------------------------------------------------------' 133 * `-----------------------------------------------------------------------------------'
134 */ 134 */
@@ -142,11 +142,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
142 /* Raise 142 /* Raise
143 * ,-----------------------------------------------------------------------------------. 143 * ,-----------------------------------------------------------------------------------.
144 * | ~ | ! | @ | # | $ | % | _ | + | Ins | Home | PgUp | | 144 * | ~ | ! | @ | # | $ | % | _ | + | Ins | Home | PgUp | |
145 * |------+------+------+------+------+-------------+------+------+------+------+------| 145 * |------+------+------+------+------+------+------+------+------+------+------+------|
146 * | Caps | ^ | & | * | ( | ) | { | } | | | " | | | 146 * | Caps | ^ | & | * | ( | ) | { | } | | | " | | |
147 * |------+------+------+------+------+------|------+------+------+------+------+------|
148 * | | F9 | F10 | F11 | F12 | | | | | | | |
149 * |------+------+------+------+------+------+------+------+------+------+------+------| 147 * |------+------+------+------+------+------+------+------+------+------+------+------|
148 * | | F9 | F10 | F11 | F12 | | | | | | | |
149 * |------+------+------+------+------+-------------+------+------+------+------+------|
150 * | | | | | | | | | | | | 150 * | | | | | | | | | | | |
151 * `-----------------------------------------------------------------------------------' 151 * `-----------------------------------------------------------------------------------'
152 */ 152 */
diff --git a/keyboards/planck/keymaps/lae3/readme.md b/keyboards/planck/keymaps/lae3/readme.md
index 429b51456..57a2f38dd 100644
--- a/keyboards/planck/keymaps/lae3/readme.md
+++ b/keyboards/planck/keymaps/lae3/readme.md
@@ -1 +1,111 @@
1Keymap based around mode-switching for extended functionality 1# Lae3
2_Keymap based around mode-switching for extended functionality_
3
4## Base Layout
5
6 ┌-----------------------------------------------------------------------------------┐
7 | Esc | Q | W | E | R | T | Y | U | I | O | P | Bksp |
8 |------+------+------+------+------+------+------+------+------+------+------+------|
9 | Tab | A | S | D | F | G | H | J | K | L | ; |Enter |
10 |------+------+------+------+------+------+------+------+------+------+------+------|
11 |Shift | Z | X | C | V | B | N | M | , | . | / |Shift |
12 |------+------+------+------+------+-------------+------+------+------+------+------|
13 | Ctrl | GUI | Alt | Move |Lower | Space |Raise | Move | Alt | GUI | Ctrl |
14 └-----------------------------------------------------------------------------------┘
15
16This is more similar to a standard keyboard layout than the standard planck
17layout, but I have found that this is better for programming, especially for
18editor shortcuts.
19
20## Lower Layer
21
22 ┌-----------------------------------------------------------------------------------┐
23 | ` | 1 | 2 | 3 | 4 | 5 | - | = | Del | End | PgDn | |
24 |------+------+------+------+------+------+------+------+------+------+------+------|
25 | Caps | 6 | 7 | 8 | 9 | 0 | [ | ] | \ | ' | | |
26 |------+------+------+------+------+------+------+------+------+------+------+------|
27 | | F1 | F2 | F3 | F4 | | | F5 | F6 | F7 | F8 | |
28 |------+------+------+------+------+-------------+------+------+------+------+------|
29 | | | | | | | | | | | |
30 └-----------------------------------------------------------------------------------┘
31
32All the numbers are on one hand so that they can all be easily accessed when
33playing games. The punctuation was placed in a way that is as similar as
34possible the qwerty punctuation layout on a standard keyboard.
35
36## Raise Layer
37
38 ┌-----------------------------------------------------------------------------------┐
39 | ~ | ! | @ | # | $ | % | _ | + | Ins | Home | PgUp | |
40 |------+------+------+------+------+------+------+------+------+------+------+------|
41 | Caps | ^ | & | * | ( | ) | { | } | | | " | | |
42 |------+------+------+------+------+------+------+------+------+------+------+------|
43 | | F9 | F10 | F11 | F12 | | | | | | | |
44 |------+------+------+------+------+-------------+------+------+------+------+------|
45 | | | | | | | | | | | |
46 └-----------------------------------------------------------------------------------┘
47
48This layer with the exception of the function and control keys is effectively
49the lower layer in combination with the shift key, like on the standard planck
50layout.
51
52## Movement Layer
53
54 ┌-----------------------------------------------------------------------------------┐
55 | |MsBut2|Ms Up |MsBut1|MsWhUp| | Home | PgDn | PgUp | End | | |
56 |------+------+------+------+------+------+------+------+------+------+------+------|
57 | |Ms Lft|Ms Dn |Ms Rgt|MsWhDn| | Left | Down | Up | Right| | |
58 |------+------+------+------+------+------+------+------+------+------+------+------|
59 | | | | | | | | | | | | |
60 |------+------+------+------+------+-------------+------+------+------+------+------|
61 | | | | | | | | | | | |
62 └-----------------------------------------------------------------------------------┘
63
64Layer for simplifying movement.
65
66## Meta Layer
67
68 ┌-----------------------------------------------------------------------------------┐
69 |Reset | | | | | | | | | | | |
70 |------+------+------+------+------+------+------+------+------+------+------+------|
71 | |Bcklgt| Mute |Vol Dn|Vol Up| | |Qwerty|Arrow |Numpad| | |
72 |------+------+------+------+------+------+------+------+------+------+------+------|
73 | | | | | | | | | | | | |
74 |------+------+------+------+------+-------------+------+------+------+------+------|
75 | | | | | | | | | | | |
76 └-----------------------------------------------------------------------------------┘
77
78This Layer is activated when pressing both the Lower and Raise keys. The Arrow
79and Numpad keys each activate a layer between the base layer and the Movement
80layer. The Qwerty key disables both of the layers leaving just the base layer
81active.
82
83## Arrow Layer
84
85 ┌-----------------------------------------------------------------------------------┐
86 | | | | | | | | | | | | |
87 |------+------+------+------+------+------+------+------+------+------+------+------|
88 | | | | | | | | | | | | |
89 |------+------+------+------+------+------+------+------+------+------+------+------|
90 | | | | | | | | | | | Up | |
91 |------+------+------+------+------+-------------+------+------+------+------+------|
92 | | | | | | | | | Left | Down | Right|
93 └-----------------------------------------------------------------------------------┘
94
95Replaces the bottom right of the keyboard with arrow keys for games like The
96Binding of Isaac.
97
98## Numpad Layer
99
100 ┌-----------------------------------------------------------------------------------┐
101 | | | | | | |NumLck| 7 | 8 | 9 | / | |
102 |------+------+------+------+------+------+------+------+------+------+------+------|
103 | | | | | | |Enter | 4 | 5 | 6 | * | |
104 |------+------+------+------+------+------+------+------+------+------+------+------|
105 | | | | | | | | 3 | 2 | 1 | - | |
106 |------+------+------+------+------+-------------+------+------+------+------+------|
107 | | | | | | | | 0 | . | + | |
108 └-----------------------------------------------------------------------------------┘
109
110Replaces the majority of the right side of the keyboard with a numpad because
111why not?