From 633d9aa53e3fc2b9fa9f01475cba9c151ab31d9a Mon Sep 17 00:00:00 2001 From: tmk Date: Tue, 5 Mar 2013 14:57:24 +0900 Subject: [PATCH] Fix README.md and doc/keymap.md --- README.md | 10 +++++++--- doc/keymap.md | 7 ++++--- 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e349ee61..b85e03dd 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Source code is available here: Features -------- -* Multi-layer Keymap - Multiple keyboard layouts with layer switching. +* Multi-layer Keymap - Multiple keyboard layouts with layer switching * Mouse key - Mouse control with keyboard * System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up * 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 * [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?) +* [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) ### keyboard * [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard professional][GH_hhkb] * [macway](keyboard/macway/) - [Compact keyboard mod][GH_macway] * [hbkb](keyboard/hbkb/) - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb] -* [IIgs_Standard](keyboard/IIgs_Standard/) - Apple IIGS keyboard mod(by JeffreySung) +* [IIgs_Standard](keyboard/IIgs_Standard/) - Apple [IIGS] keyboard mod(by JeffreySung) * [hid_liber](keyboard/hid_liber/) - [HID liberation controller][HID_liber](by alaricljs) * [phantom](keyboard/phantom/) - [Phantom keyboard][PHANTOM] (by Tranquilite) * [gh60](keyboard/gh60/) - [GH60 keyboard][GH60] @@ -56,6 +57,9 @@ You can find some keyboard specific projects under `converter` and `keyboard` di [HID_liber]: http://deskthority.net/wiki/HID_Liberation_Device_-_DIY_Instructions [PHANTOM]: http://geekhack.org/index.php?topic=26742 [GH60]: http://geekhack.org/index.php?topic=34959 +[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801 +[Sun]: http://en.wikipedia.org/wiki/Sun-3 +[IIGS]: http://en.wikipedia.org/wiki/Apple_IIGS diff --git a/doc/keymap.md b/doc/keymap.md index a20ac18a..ca48c6e5 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 2 /___________// | 2 `-------------------------- 1 /___________// | 1 `-------------------------- 0 /___________/ V low 0 `-------------------------- - + + ### 0.1 Keymap status Keymap 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 | | `--- default_layer = 0 `--- default_layer = 1 keymap_stat = 0x0001 keymap_stat = 0x0002 - On 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. @@ -62,7 +62,8 @@ On the other hand, you shall change `keymap_state` to overlay base layer with so `--- default_layer = 1 | keymap_stat = 0x6002 <-----' - + + ### 0.2 Layer Precedence and Transparency Note 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.