summaryrefslogtreecommitdiff
path: root/keyboards/satan/keymaps/spacemanspiff/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/satan/keymaps/spacemanspiff/readme.md')
-rw-r--r--keyboards/satan/keymaps/spacemanspiff/readme.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/keyboards/satan/keymaps/spacemanspiff/readme.md b/keyboards/satan/keymaps/spacemanspiff/readme.md
new file mode 100644
index 0000000000..1d592509de
--- /dev/null
+++ b/keyboards/satan/keymaps/spacemanspiff/readme.md
@@ -0,0 +1,34 @@
+# Spaceman Spiff Layout for GH60 Satan
+
+![Keyboard Layout](https://i.imgur.com/M9glFON.png)
+
+<!-- http://www.keyboard-layout-editor.com/#/gists/32feaaa31c29afb8198a8ef591db6ddf -->
+
+Designed specifically to make switching back-n-forth with the Apple's MacBook Pro keyboard intuitive. Has a slight tendency toward readline/vim keybindings.
+
+Caps locks becomes an `Esc` when pressed alone, or a `Ctrl` when pressed with another key.
+
+# Base Layer
+
+As simalar to the Apple keyboard as possible. Notiable exception is `Caps Lock`:
+- `Esc` when pressed alone
+- `Ctrl` when pressed with another key
+
+# Control+ Layer
+
+Left Ctrl key switches to the "Control+ Layer". This layer mostly acts like a control key in most cases, with a few exceptions:
+
+- `Ctl+` + `hjkl` are vim-style motion keys
+- `Ctl+` + `p` and `Ctl+` + `n` are page up and down
+- `Ctl+` + `Backspace` is forward delete
+
+# Fn Layer
+
+Audio Controls:
+- `Fn` + `a` Volume Down
+- `Fn` + `s` Volume Up
+- `Fn` + `d` Mute
+
+To flash this layout you need to press `Fn+Backspace`
+
+