summaryrefslogtreecommitdiff
path: root/keyboards/iron180/readme.md
diff options
context:
space:
mode:
authorÁlvaro A. Volpato <alvaro.volpato@usp.br>2021-12-27 07:17:12 -0300
committerGitHub <noreply@github.com>2021-12-27 21:17:12 +1100
commit52b53ccf3821c0e2855acb424f78342a0c95a400 (patch)
tree6743e90a80838917b3adb2689ceda2b388a95215 /keyboards/iron180/readme.md
parent067d94f0b6c957c4e1c0ae1d680b420651fb3766 (diff)
Add 'capslock backlight' feature to Iron180 (#15462)
* Add 'capslock backlight' capability to Iron180 * Update readme * Revers CAPSLOCK_BACKLIGHT back to default
Diffstat (limited to 'keyboards/iron180/readme.md')
-rw-r--r--keyboards/iron180/readme.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/keyboards/iron180/readme.md b/keyboards/iron180/readme.md
index 1dbffae1d4..d89ca912ef 100644
--- a/keyboards/iron180/readme.md
+++ b/keyboards/iron180/readme.md
@@ -31,3 +31,16 @@ Then, after accessing the DFU state, use a tool like `dfu-util` or the QMK Toolb
make iron180:default:flash
See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
+
+## The 'caps lock backlight' feature
+
+The Iron180 firmware allows the user to adjust the backlight according to the caps lock key. This will toggle *all backlight LEDs* according to caps lock, enabling backlight when caps is on and disabling when it is off.
+
+This option is specially useful if you are only interested in the caps lock LED and want it to work as an indicator; however, it must be noted that this works keyboard-wide, so if that is your case you should only solder the caps lock key LED and none else.
+
+This option is disabled by default; in order to enable it, you must un-comment the last line in `config.h`:
+
+ // Turn backlight on-off according to capslock
+ #define CAPSLOCK_BACKLIGHT
+
+Then compile and flash the firmware.