summaryrefslogtreecommitdiff
path: root/keyboards/planck/keymaps/callum/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/planck/keymaps/callum/readme.md')
-rw-r--r--keyboards/planck/keymaps/callum/readme.md110
1 files changed, 54 insertions, 56 deletions
diff --git a/keyboards/planck/keymaps/callum/readme.md b/keyboards/planck/keymaps/callum/readme.md
index d5a689b8f..176211cd4 100644
--- a/keyboards/planck/keymaps/callum/readme.md
+++ b/keyboards/planck/keymaps/callum/readme.md
@@ -4,8 +4,8 @@ This is a layout for the grid planck, built with a few ideals in mind:
- Consistent and minimal response times should be maintained. Keys that react
differently depending on whether they are tapped or held, keys that react
- differently if they are double tapped, etc. should be avoided – they
- inevitably send their keycode later than a normal key – interrupting the
+ differently if they are double tapped, etc. should be avoided -- they
+ inevitably send their keycode later than a normal key -- interrupting the
immediate feedback from the screen. Therefore we restrict ourselves to
chording as our only means of getting more than one symbol out of a single
physical key.
@@ -17,70 +17,68 @@ This is a layout for the grid planck, built with a few ideals in mind:
- There should be two of every modifier (one on each side), otherwise certain
long key combinations become hard to make.
-We have five layers. A `BASE` layer, in colemak; a `MOVE` layer, with an arrow
-cluster, other movement keys, and hotkeys; a `SYMB` layer, with numbers and
-symbols; a `FUNC` layer, with function keys and media keys; and a `MORE` layer,
-with stuff that doesn’t fit anywhere else. The `MORE` layer is activated by
-holding the Move and Symb keys simultaniously.
+Keys are arranged as follows. Blank keys below may actually contain
+undocumented shortcuts specific to my workflow. The base layer can be set to
+colemak or qwerty (from the function layer).
```
-/* BASE
- * ,-----------------------------------------------------------------------------------.
- * | Tab | Q | W | F | P | G | J | L | U | Y | ; | - |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Bksp | A | R | S | T | D | H | N | E | I | O | ' |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Shift| Z | X | C | V | B | K | M | , | . | / | Shift|
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Func | Ctrl | Alt | Cmd | Symb | Enter| Space| Move | Cmd | Alt | Ctrl | Func |
- * `-----------------------------------------------------------------------------------'
+/* COLEMAK
+ * ,-----------------------------------------------------------------------.
+ * |Tab | Q | W | F | P | G | J | L | U | Y | ; | - |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * |Bksp | A | R | S | T | D | H | N | E | I | O | ' |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * |Shift| Z | X | C | V | B | K | M | , | . | / |Shift|
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * |FUNC |Super| Alt |Ctrl |SYMB |Enter|Space|MOVE |Ctrl | Alt |Super|FUNC |
+ * `-----------------------------------------------------------------------'
*/
-/* MOVE
- * ,-----------------------------------------------------------------------------------.
- * | H(F7)| H(F8)| H(6) | H(5) | H(4) | H(F9)|H(F10)| Home | Up | End | H(A) | Esc |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | H(F3)| H(F4)| H(3) | H(2) | H(1) | H(F5)| H(F6)| Left | Down | Right| Caps | Del |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | H(0) | H(9) | H(8) | H(7) | H(F1)| H(F2)| Pg Dn| Pg Up|H(F11)|H(F12)| |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | | | | | | | | | | | |
- * `-----------------------------------------------------------------------------------'
+/* QWERTY
+ * ,-----------------------------------------------------------------------.
+ * |Tab | Q | W | E | R | T | Y | U | I | O | P | - |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * |Bksp | A | S | D | F | G | H | J | K | L | ; | ' |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * |Shift| Z | X | C | V | B | N | M | , | . | / |Shift|
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * |FUNC |Super| Alt |Ctrl |SYMB |Enter|Space|MOVE |Ctrl | Alt |Super|FUNC |
+ * `-----------------------------------------------------------------------'
*/
/* SYMB
- * ,-----------------------------------------------------------------------------------.
- * | Esc | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | – |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Del | ! | @ | # | $ | % | ^ | & | * | ( | ) | ’ |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | ~ | ` | + | = | | | \ | [ | ] | { | } | |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | | | | | | | | | | | |
- * `-----------------------------------------------------------------------------------'
+ * ,-----------------------------------------------------------------------.
+ * | Esc | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | Del | ! | @ | # | $ | % | ^ | & | * | ( | ) | |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | | ~ | ` | + | = | | | \ | [ | ] | { | } | |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------'
*/
-/* MORE
- * ,-----------------------------------------------------------------------------------.
- * | | | | | | | | | | | | |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | | | | £ | | | | | | | |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | | | | | | | “ | ” | ‘ | ’ | |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | | | | | | | | | | | |
- * `-----------------------------------------------------------------------------------'
+/* MOVE
+ * ,-----------------------------------------------------------------------.
+ * | | | | | | | |Home | Up | End | | Esc |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | | | | | | | |Left |Down |Right|Caps | Del |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | | | | | | | |PgDn |PgUp | | | |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | | | | | | | | | | | | |
+ * `-----------------------------------------------------------------------'
*/
/* FUNC
- * ,-----------------------------------------------------------------------------------.
- * | Reset| F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | Vol+ |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | Power| F11 | F12 | F13 | F14 | F15 | F16 | F17 | F18 | F19 | F20 | Vol- |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | F21 | F22 | F23 | F24 | | | | | | | |
- * |------+------+------+------+------+------+------+------+------+------+------+------|
- * | | | | | Prev | Mute | Play | Next | | | | |
- * `-----------------------------------------------------------------------------------'
+ * ,-----------------------------------------------------------------------.
+ * |Reset| F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 |VolUp|
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * |Power| F11 | F12 | F13 | F14 | F15 | F16 | F17 | F18 | F19 | F20 |VolDn|
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | | F21 | F22 | F23 | F24 | | | | |COLMK|QWRTY| |
+ * |-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----+-----|
+ * | | | | |Prev |Mute |Play |Next | | | | |
+ * `-----------------------------------------------------------------------'
*/
-```
+ ```