[Keyboard] Adding LED support to the plaid default keycap (#6109)

[qmk_firmware.git] / keyboards / plaid / keymaps / default / readme.md

diff --git a/keyboards/plaid/keymaps/default/readme.md b/keyboards/plaid/keymaps/default/readme.md
index 6f68e46af4ef8ddf31293fa0335494c4d86fe7da..2f491e36753b53d2781f086bf3af9ca7547d433b 100644 (file)
--- a/keyboards/plaid/keymaps/default/readme.md
+++ b/keyboards/plaid/keymaps/default/readme.md
@@ -1,2 +1,32 @@
 # The default keymap for plaid
-folk from planck
+Original copyright 2019 Takuya Urakawa (dm9records.com)
+LED Support added  by Richard Sutherland (rich@brickbots.com)
+
+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: 
+
+Activates when any modifier (shift, alt, os, MO) key is held
+down.  LED turns off when key is release
+
+Blinkinlights Mode:
+Random chance of state change on each keystroke.
+
+Keypress Mode:
+On for any keypress as long as the key is pressed
+
+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