From fced377ac007d27f2650ccffbe0b18abcdcfe23d Mon Sep 17 00:00:00 2001
From: James Young <18669334+noroadsleft@users.noreply.github.com>
Date: Sat, 30 May 2020 13:14:59 -0700
Subject: 2020 May 30 Breaking Changes Update (#9215)

* Branch point for 2020 May 30 Breaking Change

* Migrate `ACTION_LAYER_TOGGLE` to `TG()` (#8954)

* Migrate `ACTION_MODS_ONESHOT` to `OSM()` (#8957)

* Migrate `ACTION_DEFAULT_LAYER_SET` to `DF()` (#8958)

* Migrate `ACTION_LAYER_MODS` to `LM()` (#8959)

* Migrate `ACTION_MODS_TAP_KEY` to `MT()` (#8968)

* Convert V-USB usbdrv to a submodule (#8321)

* Unify Tap Hold functions and documentation (#8348)

* Changing board names to prevent confusion (#8412)

* Move the Keyboardio Model01 to a keyboardio/ subdir (#8499)

* Move spaceman keyboards (#8830)

* Migrate miscellaneous `fn_actions` entries (#8977)

* Migrate `ACTION_MODS_KEY` to chained mod keycodes (#8979)

* Organizing my keyboards (plaid, tartan, ergoinu) (#8537)

* Refactor Lily58 to use split_common (#6260)

* Refactor zinc to use split_common (#7114)

* Add a message if bin/qmk doesn't work (#9000)

* Fix conflicting types for 'tfp_printf' (#8269)

* Fixed RGB_DISABLE_AFTER_TIMEOUT to be seconds based & small internals cleanup (#6480)

* Refactor and updates to TKC1800 code (#8472)

* Switch to qmk forks for everything (#9019)

* audio refactor: replace deprecated PLAY_NOTE_ARRAY (#8484)

* Audio enable corrections (2/3) (#8903)

* Split HHKB to ANSI and JP layouts and Add VIA support for each (#8582)

* Audio enable corrections (Part 4) (#8974)

* Fix typo from PR7114 (#9171)

* Augment future branch Changelogs (#8978)

* Revert "Branch point for 2020 May 30 Breaking Change"
---
 .../dm9records/plaid/keymaps/brickbots/readme.md   | 36 ++++++++++++++++++++++
 1 file changed, 36 insertions(+)
 create mode 100644 keyboards/dm9records/plaid/keymaps/brickbots/readme.md

(limited to 'keyboards/dm9records/plaid/keymaps/brickbots/readme.md')

diff --git a/keyboards/dm9records/plaid/keymaps/brickbots/readme.md b/keyboards/dm9records/plaid/keymaps/brickbots/readme.md
new file mode 100644
index 0000000000..48a12fa8bb
--- /dev/null
+++ b/keyboards/dm9records/plaid/keymaps/brickbots/readme.md
@@ -0,0 +1,36 @@
+# Brickbots keymap for plaid
+Original copyright 2019 Takuya Urakawa (dm9records.com)
+LED Support added by Richard Sutherland (rich@brickbots.com)
+
+This layout is based on the Planck layout, with esc/tab swapped and an extra
+ctrl key in the bottom left corner. It 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
+
+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
-- 
cgit v1.2.1