summaryrefslogtreecommitdiff
path: root/keyboards/bpiphany/ghost_squid/keymaps/default/readme.md
diff options
context:
space:
mode:
authorJames Young <18669334+noroadsleft@users.noreply.github.com>2022-10-22 13:48:29 -0700
committerGitHub <noreply@github.com>2022-10-22 21:48:29 +0100
commit69719db6e99750d5de911ffe0dfb01f6f666d19f (patch)
treeb6fc07bd678186cc7322a3213e1669a08ce85383 /keyboards/bpiphany/ghost_squid/keymaps/default/readme.md
parentaf02e24aa7eb9fa7df646f5ebcc3a18601f6314d (diff)
Bathroom Epiphanies Ghost Squid Refactor (#18816)
* refactor default keymap - shorten layer names - KM_QWERTY -> _QW - KM_MEDIA -> _MD - KM_GUI_LOCK -> _GL - use QMK-native keycode aliases - use four-space indent - grid-align keycodes * remove third layer from default keymap The third layer only serves to disable the GUI keys, which we can do with a keycode. * update default keymap readme * ghost_squid.h: add matrix diagram * add LAYOUT_fullsize_ansi * add LAYOUT_fullsize_iso * use LAYOUT_fullsize_iso macro in default keymap Refactor the default keymap to use the new LAYOUT_fullsize_iso macro. * remove LAYOUT macro Same matrix as LAYOUT_fullsize_iso, but in a different assignment order. * enable Community Layout support
Diffstat (limited to 'keyboards/bpiphany/ghost_squid/keymaps/default/readme.md')
-rw-r--r--keyboards/bpiphany/ghost_squid/keymaps/default/readme.md34
1 files changed, 33 insertions, 1 deletions
diff --git a/keyboards/bpiphany/ghost_squid/keymaps/default/readme.md b/keyboards/bpiphany/ghost_squid/keymaps/default/readme.md
index 3c27324d1c..a6fa001740 100644
--- a/keyboards/bpiphany/ghost_squid/keymaps/default/readme.md
+++ b/keyboards/bpiphany/ghost_squid/keymaps/default/readme.md
@@ -1 +1,33 @@
-# Default layout desc TODO
+# Ghost Squid Default Keymap
+
+## Base Layer
+
+```
+ ┌───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┬───┐ ┌───┬───┬───┐ ┌───────────┐
+ │ESC│ │F1 │F2 │F3 │F4 │ │F5 │F6 │F7 │F8 │ │F9 │F10│F11│F12│ │PRT│SCR│PAU│ │Ghost Squid│
+ └───┘ └───┴───┴───┴───┘ └───┴───┴───┴───┘ └───┴───┴───┴───┘ └───┴───┴───┘ └───────────┘
+ ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌───┬───┬───┐ ┌───┬───┬───┬───┐
+ │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ Backsp│ │INS│HOM│PgU│ │NUM│ / │ * │ - │
+ ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├───┼───┼───┤ ├───┼───┼───┼───┤
+ │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ │ │DEL│END│PgD│ │ 7 │ 8 │ 9 │ │
+ ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┐ Ent│ └───┴───┴───┘ ├───┼───┼───┤ + │
+ │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ \ │ │ │ 7 │ 8 │ 9 │ │
+ ├────┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴───┴────┤ ┌───┐ ├───┼───┼───┼───┤
+ │Shif│ # │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift │ │ ↑ │ │ 1 │ 2 │ 3 │ │
+ ├────┼───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴───┼───┴┬────┬────┤ ┌───┼───┼───┐ ├───┴───┼───┤Ent│
+ │Ctrl│GUI │Alt │ │ Alt│ GUI│Fn │Ctrl│ │ ← │ ↓ │ → │ │ 0 │ , │ │
+ └────┴────┴────┴────────────────────────┴────┴────┴────┴────┘ └───┴───┴───┘ └───────┴───┴───┘
+
+```
+
+## Function Layer
+
+* `Fn` + `F5` = Play
+* `Fn` + `F6` = Stop
+* `Fn` + `F7` = Previous Track
+* `Fn` + `F8` = Next Track
+* `Fn` + `F9` = Toggle GUI key
+* `Fn` + `F10` = Mute
+* `Fn` + `F11` = Volume Down
+* `Fn` + `F12` = Volume Up
+* `Fn` + `Pause` = Reset to Bootloader