Update of IS_COMMAND (thanks to ibm4704 branch)

[tmk_firmware.git] / README.md

diff --git a/README.md b/README.md
index 5065f27880a7910f4b3feefa704706cec7362cb1..536cc753fb58076f90061db8c4b96a945bab950b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -49,6 +49,7 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
 * [phantom](keyboard/phantom/)              - [Phantom] keyboard (by Tranquilite)
 * [IIgs_Standard](keyboard/IIgs/)           - Apple [IIGS] keyboard mod(by JeffreySung)
 * [macway](keyboard/macway/)                - [Compact keyboard mod][GH_macway] [retired]
+* [KMAC](keyboard/kmac/)                    - Korean custom keyboard
 
 [GH_macway]:    http://geekhack.org/showwiki.php?title=Island:11930
 [GH_hhkb]:      http://geekhack.org/showwiki.php?title=Island:12047
@@ -123,6 +124,8 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag
 Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
 Note that you must use keys of **Layer 0** as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
 
+To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be pressed along with the following configuration keys. The salt key is configurable in `config.h`. See [common/bootmagic.h](common/bootmagic.h).
+
 #### General
 - Skip reading EEPROM to start with default configuration(`ESC`)
 - Clear configuration stored in EEPROM to reset configuration(`Backspace`)
@@ -163,12 +166,12 @@ TODO: Magic key combination to avoid unintentional press during plug in
 **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.
+Mechanical Locking support
+--------------------------
+This feature makes it possible for you to use mechanical switch for `CapsLock`, `NumLock` or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LNUM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Resync option tries to keep lock switch state consistent with keyboard LED state.
  
-    #define CAPSLOCK_LOCKING_ENABLE
-    #define CAPSLOCK_LOCKING_RESYNC_ENABLE
+    #define LOCKING_SUPPORT_ENABLE
+    #define LOCKING_RESYNC_ENABLE
 
 
 Start Your Own Project