summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authortmk <nobody@nowhere>2013-03-12 03:36:53 +0100
committertmk <nobody@nowhere>2013-03-12 03:36:53 +0100
commitc0137b4b32f10d6a5b5a405ccd284b4194fe2497 (patch)
treea0f6547c76a50778632196237eeb1d47b0f5406d /README.md
parent738baccb8fdcb4fd7e4a2ae08fe92a63710be433 (diff)
downloadqmk_firmware-c0137b4b32f10d6a5b5a405ccd284b4194fe2497.tar.gz
qmk_firmware-c0137b4b32f10d6a5b5a405ccd284b4194fe2497.tar.xz
Add description of Locking CapsLock in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index 86d9ec55f..c0b31deca 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
-----------------------