X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=README.md;h=536cc753fb58076f90061db8c4b96a945bab950b;hb=976b595c2ea4c17aee22004389f5f23be75d9d7e;hp=f3cfacb47d2dad1c4fa94f3ad9af1848a945bf5b;hpb=adbd15d5bdbd5f28657d0fa0ecdcf25768b4267d;p=tmk_firmware.git diff --git a/README.md b/README.md index f3cfacb..536cc75 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ These features can be used in your keyboard. * Virtual DIP Switch - Configurations stored EEPROM(Boot Magic) * Locking CapsLock - Mechanical switch support for CapsLock * Breathing Sleep LED - Sleep indicator with charm during USB suspend +* Backlight - Control backlight levels Projects @@ -48,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 @@ -122,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`) @@ -149,16 +153,25 @@ Note that you must use keys of **Layer 0** as Magic keys. These settings are sto - Set Default Layer to 1(`1`) - Set Default Layer to 2(`2`) - Set Default Layer to 3(`3`) +- Set Default Layer to 4(`4`) +- Set Default Layer to 5(`5`) +- Set Default Layer to 6(`6`) +- Set Default Layer to 7(`7`) + +#### Caution +Unintentional use of this feature will cause user confusion. + +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