summaryrefslogtreecommitdiff
path: root/keyboards/1upkeyboards/1up60rgb/keymaps/raffle/readme.md
diff options
context:
space:
mode:
authorMechMerlin <30334081+mechmerlin@users.noreply.github.com>2018-08-26 09:30:12 -0700
committerDrashna Jaelre <drashna@live.com>2018-08-26 09:30:12 -0700
commit1ee545014a0415eee8cbe4a3773002fb13371d14 (patch)
tree2a4320e2dce1035b6b31909b9d93742418680178 /keyboards/1upkeyboards/1up60rgb/keymaps/raffle/readme.md
parenteb19fb5b57487747d608fad986a70296da4deb12 (diff)
Keyboard: Make a 1upkeyboards directory for visibility (#3759)
Diffstat (limited to 'keyboards/1upkeyboards/1up60rgb/keymaps/raffle/readme.md')
-rw-r--r--keyboards/1upkeyboards/1up60rgb/keymaps/raffle/readme.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/keyboards/1upkeyboards/1up60rgb/keymaps/raffle/readme.md b/keyboards/1upkeyboards/1up60rgb/keymaps/raffle/readme.md
new file mode 100644
index 0000000000..c462c206ac
--- /dev/null
+++ b/keyboards/1upkeyboards/1up60rgb/keymaps/raffle/readme.md
@@ -0,0 +1,43 @@
+## raffle's keymap
+The default keymap is just enough to get started. This keymap adds a pok3r-like
+raise layer, backlight RGB control layer, and firmware reset/debug adjust layer
+for ANSI layouts.
+
+In the default layer, the following modifications are made (using standard ANSI
+keys for LHS):
+
+- `CAPS` = `LCTRL`
+- `LCTRL` = `RAISE`
+- `APP` = `RGB`
+- `LCTRL` + `APP` (`RAISE` + `RGB`) = `ADJUST`
+- `GRV` = `ESC`
+
+Additionally, the pok3r's `SHIFT` + `ESC` for `~` is maintained (with either `SHIFT`).
+
+### Raise Layer
+Emulates standard pok3r layout (without the onboard macro keys)
+
+Highlights:
+
+- `IJKL` for arrow keys
+- `H`/`N` for `HOME`/`END`
+- `U`/`P` for `PGUP`/`PGDN`
+- `1` - `=` for `F1` - `F12`
+- `Y` for calculator
+
+Other standard keys from the pok3r layout are carried over. See the keymap or
+the pok3r documentation for details.
+
+### RGB Layer
+Uses navigation keys from `RAISE` layer for RGB adjustment
+
+- `I`/`K` for Value (brightness) Increase/Decrease
+- `U`/`P` for Hue (color) Increase/Decrease
+- `H`/`N` for Saturation Incrase/Decrease
+- `GRV` to toggle RGB on/off
+- `1`-`9` to activate QMK's predefined RGB animations
+
+### Adjust Layer
+
+- `GRV` activates firmware reset for flashing
+- `1` enters debug mode