summaryrefslogtreecommitdiff
path: root/keyboards/plaid/keymaps/default/readme.md
diff options
context:
space:
mode:
authorbrickbots <rich@brickbots.com>2019-06-11 15:56:06 -0700
committerDrashna Jaelre <drashna@live.com>2019-06-11 15:56:06 -0700
commit5343eaf89a1fb4e4f5a88ace3dee9cfa1354deeb (patch)
tree5703db1b11d4dcda0f991998017e99ebfc9de4ab /keyboards/plaid/keymaps/default/readme.md
parente6a81133dd3d0d4076a08be76340f905fdbf7c7f (diff)
[Keymap] Adding personal keymap / clarifying default keymap readme (#6119)
* Adding led support for Plaid * Adding led support for Plaid * Update readme.md Fixing bad markdown * Adding my personal keymap * Clarifying LED instructions / formatting
Diffstat (limited to 'keyboards/plaid/keymaps/default/readme.md')
-rw-r--r--keyboards/plaid/keymaps/default/readme.md33
1 files changed, 18 insertions, 15 deletions
diff --git a/keyboards/plaid/keymaps/default/readme.md b/keyboards/plaid/keymaps/default/readme.md
index 2f491e3675..5a08a1fff3 100644
--- a/keyboards/plaid/keymaps/default/readme.md
+++ b/keyboards/plaid/keymaps/default/readme.md
@@ -6,27 +6,30 @@ This layout is based on the Planck layout, and includes an adjust layer (6)
accessible by holding the lower and raise modifiers (MO3 and MO4) together.
The adjustment layer is used to set the behavior of the two LEDs:
-Modifier Mode:
-
+**Modifier Mode:**
Activates when any modifier (shift, alt, os, MO) key is held
down. LED turns off when key is release
-Blinkinlights Mode:
+**Blinkinlights Mode:**
Random chance of state change on each keystroke.
-Keypress Mode:
+**Keypress Mode:**
On for any keypress as long as the key is pressed
-Carriage Mode:
+**Carriage Mode:**
Turns on when enter is pressed, turns off when any next key is pressed
-q = Toggle Red LED state, deactivates any other modes
-w = Toggle Green LED state, deactivates any other modes
-e = Set RED LED to modifier mode
-r = Set GREEN LED to modifier mode
-t = Set RED LED to Blinkinlights mode
-y = set GREEN LED to Blinkinlights mode
-u = set RED LED to Keypress mode
-i = set GREEN LED to Keypress mode
-o = set RED LED to Carriage mode
-p = set GREEN LED to Carriage mode
+To set the behavior of an LED, and save it to eeprom, hold the
+raise/lower keys together to access the adjust layer, then use
+the keys indicated below to set the behaviors
+
+* q = Toggle Red LED state, deactivates any other modes
+* w = Toggle Green LED state, deactivates any other modes
+* e = Set RED LED to modifier mode
+* r = Set GREEN LED to modifier mode
+* t = Set RED LED to Blinkinlights mode
+* y = set GREEN LED to Blinkinlights mode
+* u = set RED LED to Keypress mode
+* i = set GREEN LED to Keypress mode
+* o = set RED LED to Carriage mode
+* p = set GREEN LED to Carriage mode