aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md10
-rw-r--r--doc/keymap.md7
2 files changed, 11 insertions, 6 deletions
diff --git a/README.md b/README.md
index e349ee61d..b85e03ddb 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ Source code is available here: <http://github.com/tmk/tmk_keyboard>
7 7
8Features 8Features
9-------- 9--------
10* Multi-layer Keymap - Multiple keyboard layouts with layer switching. 10* Multi-layer Keymap - Multiple keyboard layouts with layer switching
11* Mouse key - Mouse control with keyboard 11* Mouse key - Mouse control with keyboard
12* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up 12* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up
13* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc 13* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc
@@ -31,14 +31,15 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
31* [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal] 31* [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
32* [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news] 32* [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
33* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k] 33* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
34* [sun_usb](converter/sun_usb/) - Sun to USB(type4, 5 and 3?) 34* [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
35* [pc98_usb](converter/pc98_usb/) - [PC98] to USB
35* [usb_usb](converter/usb_usb/) - USB to USB(experimental) 36* [usb_usb](converter/usb_usb/) - USB to USB(experimental)
36 37
37### keyboard 38### keyboard
38* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard professional][GH_hhkb] 39* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard professional][GH_hhkb]
39* [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] 40* [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway]
40* [hbkb](keyboard/hbkb/) - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb] 41* [hbkb](keyboard/hbkb/) - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
41* [IIgs_Standard](keyboard/IIgs_Standard/) - Apple IIGS keyboard mod(by JeffreySung) 42* [IIgs_Standard](keyboard/IIgs_Standard/) - Apple [IIGS] keyboard mod(by JeffreySung)
42* [hid_liber](keyboard/hid_liber/) - [HID liberation controller][HID_liber](by alaricljs) 43* [hid_liber](keyboard/hid_liber/) - [HID liberation controller][HID_liber](by alaricljs)
43* [phantom](keyboard/phantom/) - [Phantom keyboard][PHANTOM] (by Tranquilite) 44* [phantom](keyboard/phantom/) - [Phantom keyboard][PHANTOM] (by Tranquilite)
44* [gh60](keyboard/gh60/) - [GH60 keyboard][GH60] 45* [gh60](keyboard/gh60/) - [GH60 keyboard][GH60]
@@ -56,6 +57,9 @@ You can find some keyboard specific projects under `converter` and `keyboard` di
56[HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions 57[HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions
57[PHANTOM]: http://geekhack.org/index.php?topic=26742 58[PHANTOM]: http://geekhack.org/index.php?topic=26742
58[GH60]: http://geekhack.org/index.php?topic=34959 59[GH60]: http://geekhack.org/index.php?topic=34959
60[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
61[Sun]: http://en.wikipedia.org/wiki/Sun-3
62[IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS
59 63
60 64
61 65
diff --git a/doc/keymap.md b/doc/keymap.md
index a20ac18a2..ca48c6e5a 100644
--- a/doc/keymap.md
+++ b/doc/keymap.md
@@ -20,7 +20,8 @@ respective layers can be validated simultaneously. Layers are indexed with 0 to
20 2 /___________// | 2 `-------------------------- 20 2 /___________// | 2 `--------------------------
21 1 /___________// | 1 `-------------------------- 21 1 /___________// | 1 `--------------------------
22 0 /___________/ V low 0 `-------------------------- 22 0 /___________/ V low 0 `--------------------------
23 23
24
24 25
25### 0.1 Keymap status 26### 0.1 Keymap status
26Keymap has its state in two parameters: 27Keymap has its state in two parameters:
@@ -43,7 +44,6 @@ To change `default_layer` will be useful when you want to switch key layout comp
43 | | 44 | |
44 `--- default_layer = 0 `--- default_layer = 1 45 `--- default_layer = 0 `--- default_layer = 1
45 keymap_stat = 0x0001 keymap_stat = 0x0002 46 keymap_stat = 0x0001 keymap_stat = 0x0002
46
47 47
48On the other hand, you shall change `keymap_state` to overlay base layer with some layers for feature such as navigation keys, function key(F1-F12), media keys or special actions. 48On the other hand, you shall change `keymap_state` to overlay base layer with some layers for feature such as navigation keys, function key(F1-F12), media keys or special actions.
49 49
@@ -62,7 +62,8 @@ On the other hand, you shall change `keymap_state` to overlay base layer with so
62 `--- default_layer = 1 | 62 `--- default_layer = 1 |
63 keymap_stat = 0x6002 <-----' 63 keymap_stat = 0x6002 <-----'
64 64
65 65
66
66### 0.2 Layer Precedence and Transparency 67### 0.2 Layer Precedence and Transparency
67Note that ***higher layer has higher priority on stack of layers***, namely firmware falls down from top layer to bottom to look up keycode. Once it spots keycode other than **`KC_TRNS`**(transparent) on a layer it stops searching and lower layers aren't referred. 68Note that ***higher layer has higher priority on stack of layers***, namely firmware falls down from top layer to bottom to look up keycode. Once it spots keycode other than **`KC_TRNS`**(transparent) on a layer it stops searching and lower layers aren't referred.
68 69