summaryrefslogtreecommitdiff
path: root/keyboard/kc60/keymaps/stanleylai/README.md
diff options
context:
space:
mode:
authorStanley Lai <stanleylai.sg@gmail.com>2016-06-20 21:49:54 -0700
committerJack Humbert <jack.humb@gmail.com>2016-06-21 00:49:54 -0400
commitc976c03547e069d76bb26577fbbfc29c894d17fa (patch)
tree59dd72065f72db0580b77b457196ba7e1415f4f3 /keyboard/kc60/keymaps/stanleylai/README.md
parent650e77c6576b7893b430ba210be6ae439e363516 (diff)
Added stanleylai's personal keymap (#420)
* Added WS2812 support for KC60 * Reorganized WS2812 support into its own keymap * Fixed relative link in README * Moved WS2812 mention in README to the bottom * Fixed titling in WS2812 README * Reverted KC60 Makefile and default keymap back * Moved RGB specific config.h to ws2812 keymap folder * Added my personal keymap * Updated compiled hex * Reverted KC60 files to 3f6fac47 before pull request #419
Diffstat (limited to 'keyboard/kc60/keymaps/stanleylai/README.md')
-rw-r--r--keyboard/kc60/keymaps/stanleylai/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/keyboard/kc60/keymaps/stanleylai/README.md b/keyboard/kc60/keymaps/stanleylai/README.md
new file mode 100644
index 0000000000..a7daa6e77f
--- /dev/null
+++ b/keyboard/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`.