X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=README.md;h=b76b7fb9ed3a0300d3c508d1bc075728bafb3088;hb=a35cf0e458090388202c2a0783c5d34f9b69acf7;hp=aae350d08f9b7103e89615b010ee023e8818ae97;hpb=5a0415749d6cd6a095d9c3fbb335360ec5fa59e0;p=max%2Ftmk_keyboard.git

diff --git a/README.md b/README.md
index aae350d0..b76b7fb9 100644
--- a/README.md
+++ b/README.md
@@ -33,13 +33,14 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
 ### converter
 * [ps2_usb](converter/ps2_usb/)             - [PS/2 keyboard to USB][GH_ps2]
 * [adb_usb](converter/adb_usb/)             - [ADB keyboard to USB][GH_adb]
-* [m0110_usb](converter/m0110_usb)          - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
+* [m0110_usb](converter/m0110_usb)          - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
 * [terminal_usb](converter/terminal_usb/)   - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
 * [news_usb](converter/news_usb/)           - [Sony NEWS keyboard to USB][GH_news]
 * [x68k_usb](converter/x68k_usb/)           - [Sharp X68000 keyboard to USB][GH_x68k]
 * [sun_usb](converter/sun_usb/)             - [Sun] to USB(type4, 5 and 3?)
 * [pc98_usb](converter/pc98_usb/)           - [PC98] to USB
 * [usb_usb](converter/usb_usb/)             - USB to USB(experimental)
+* [ascii_usb](converter/ascii_usb/)         - ASCII(Serial console terminal) to USB
 
 ### keyboard
 * [hhkb](keyboard/hhkb/)                    - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
@@ -90,7 +91,7 @@ See [doc/keymap.md](doc/keymap.md).
 
 
 
-Magic Comannds
+Magic Commands
 --------------
 To see help press `Magic` + `H`.
 
@@ -121,9 +122,11 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag
 **TBD**
 
 ### Boot Magic Configuration - Virtual DIP Switch
-Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
+Boot Magic are executed during boot up time. Press Magic key below then plug in 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`)
@@ -139,7 +142,7 @@ Note that you must use keys of **Layer 0** as Magic keys. These settings are sto
 
 #### Keymap
 - Swap Control and CapsLock(`Left Control`)
-- Change CapsLock to Control(`Casp Lock`)
+- Change CapsLock to Control(`Caps Lock`)
 - Swap LeftAlt and Gui(`Left Alt`)
 - Swap RightAlt and Gui(`Right Alt`)
 - Disable Gui(`Left Gui`)
@@ -164,12 +167,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
@@ -208,7 +211,7 @@ Architecture
 
 
 
-Debuging
+Debugging
 --------
 Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
 
@@ -225,7 +228,7 @@ Files and Directories
 * converter/    - protocol converter projects
 * doc/          - documents
 * common.mk     - Makefile for common
-* protoco.mk    - Makefile for protocol
+* protocol.mk    - Makefile for protocol
 * rules.mk      - Makefile for build rules
 
 ### Common
@@ -261,7 +264,7 @@ Files and Directories
 
 
 
-Conding Style
+Coding Style
 -------------
 - Doesn't use Tab to indent, use 4-spaces instead.