From: tmk <nobody@nowhere>
Date: Tue, 12 Mar 2013 02:36:53 +0000 (+0900)
Subject: Add description of Locking CapsLock in README
X-Git-Url: https://git.friedersdorff.com/?a=commitdiff_plain;h=c0137b4b32f10d6a5b5a405ccd284b4194fe2497;p=max%2Ftmk_keyboard.git

Add description of Locking CapsLock in README
---

diff --git a/README.md b/README.md
index 86d9ec55..c0b31dec 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ Features
 * Keyboard Tricks     - Oneshot modifier and modifier with tapping feature
 * Debug Console       - Messages for debug and interaction with firmware
 * Virtual DIP Switch  - Configurations stored EEPROM(Boot Magic)
+* Locking CapsLock    - Mechanical switch support for CapsLock
 
 
 Projects
@@ -296,6 +297,13 @@ These settings are stored in EEPROM.
 **TBD**
 
 
+Mechanical Locking support for CapsLock
+---------------------------------------
+To enable this feature define these two macros in `config.h` and use `KC_LCAP` for locking CapsLock in keymap instead of normal `KC_CAPS`. Resync option tries to keep lock switch state consistent with keyboard LED state.
+ 
+    #define CAPSLOCK_LOCKING_ENABLE
+    #define CAPSLOCK_LOCKING_RESYNC_ENABLE
+
 
 Start Your Own Project
 -----------------------