summaryrefslogtreecommitdiff
path: root/keyboards/kc60/keymaps/stanleylai/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/kc60/keymaps/stanleylai/README.md')
-rw-r--r--keyboards/kc60/keymaps/stanleylai/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboards/kc60/keymaps/stanleylai/README.md b/keyboards/kc60/keymaps/stanleylai/README.md
new file mode 100644
index 0000000000..a7daa6e77f
--- /dev/null
+++ b/keyboards/kc60/keymaps/stanleylai/README.md
@@ -0,0 +1,26 @@
+Stanley Lai's Split Right Shift with Dedicated Arrow Keys
+======================
+
+![Image of KC60 with RGB Underglow](../ws2812/ws2812_example.jpg)
+
+## Quantum MK Firmware
+For the full Quantum feature list, see [the parent README.md](/README.md).
+
+## Keymap Notes
+- Keymap setup with split Right Shift in mind.
+- Right-side modifiers are setup as dedicated arrow keys
+
+### Base Layer Reference
+- Fn Layer indicated on keycap front legends.
+- Tapping Caps Lock key toggles Caps. Holding it down momentarily switches us to the Fn Layer.
+- Holding down "Fn" and "Page Down" momentarily switches us to the RGB Layer. Tapping "Page Down" behaves as expected.
+![Base Layer](base_layer.jpg)
+
+### RGB Layer Reference
+![RGB Layer](rgb_layer.jpg)
+
+## WS2812 Support
+By default, it is now setup for 16 LEDs on the PF5 breakout pin. See [included image](../ws2812/ws2812_wiring.jpg) for wiring reference.
+
+### Build
+To build this keymap, simply run `make KEYMAP=stanleylai`.