Move Phantom keymaps to separate header files.

[qmk_firmware.git] / README.md

diff --git a/README.md b/README.md
index 998d99a00d8a04a85631fde7c79d8e3188b7a111..f3cfacb47d2dad1c4fa94f3ad9af1848a945bf5b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -102,10 +102,11 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag
     x:      toggle matrix debug
     k:      toggle keyboard debug
     m:      toggle mouse debug
-    p:      toggle print enable
     v:      print device version & info
     t:      print timer count
     s:      print status
+    e:     print eeprom config
+    n:     toggle NKRO
     0/F10:  switch to Layer0
     1/F1:   switch to Layer1
     2/F2:   switch to Layer2
@@ -117,13 +118,24 @@ Following commands can be also executed with `Magic` + key. In console mode `Mag
 
 **TBD**
 
-### Conguration with Boot Magic
+### Boot Magic Configuration - Virtual DIP Switch
 Boot Magic are executed during boot up time. Press Magic key below then pulgin keyboard cable.
-These settings are stored in EEPROM.
+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.
 
-- Clear configuration stored in EEPROM(`Backspace`)
+#### General
+- Skip reading EEPROM to start with default configuration(`ESC`)
+- Clear configuration stored in EEPROM to reset configuration(`Backspace`)
+
+#### Bootloader
 - Kick up Bootloader(`B`)
+
+#### Debug
 - Debug enable(`D`)
+- Debug matrix enable(`D`+`X`)
+- Debug keyboard enable(`D`+`K`)
+- Debug mouse enable(`D`+`M`)
+
+#### Keymap
 - Swap Control and CapsLock(`Left Control`)
 - Change CapsLock to Control(`Casp Lock`)
 - Swap LeftAlt and Gui(`Left Alt`)
@@ -132,6 +144,12 @@ These settings are stored in EEPROM.
 - Swap Grave and Escape(`Grave`)
 - Swap BackSlash and BackSpace(`Back Slash`)
 
+#### Default Layer
+- Set Default Layer to 0(`0`)
+- Set Default Layer to 1(`1`)
+- Set Default Layer to 2(`2`)
+- Set Default Layer to 3(`3`)
+
 **TBD**
 
 
@@ -183,29 +201,7 @@ Debuging
 --------
 Use PJRC's `hid_listen` to see debug messages. You can use the tool for debug even if firmware use LUFA stack.
 
-You will see output from firmware like this.
-
-    r/c 01234567
-    00: 00000000
-    01: 00000000
-    02: 00000000
-    03: 00000000
-    04: 00000000
-    05: 00000000
-    06: 00000000
-    07: 00000000
-
-    ---- action_exec: start -----
-    EVENT: 0307u(22511)
-    Tapping: Tap release(2)
-    ACTION: ACT_LAYER[5:2C]
-    LAYER_PRESSED: Tap: unregister_code
-    TAPPING_KEY=0307u(22511):2
-    processed: 0307u(22511):2
-
-    Tapping: End(Timeout after releasing last tap): FFFFu(22715)
-    TAPPING_KEY=0000u(0):0
-
+You can use xprintf() to display debug info on `hid_listen`, see `common/xprintf.h`.
 
 
 
@@ -254,6 +250,12 @@ Files and Directories
 
 
 
+Conding Style
+-------------
+- Doesn't use Tab to indent, use 4-spaces instead.
+
+
+
 Other Keyboard Firmware Projects
 ------------------
 See [doc/other_projects.md](doc/other_projects.md).