Fix READEM of hhkb and doc/build.md

[tmk_firmware.git] / keyboard / hhkb / README.md

diff --git a/keyboard/hhkb/README.md b/keyboard/hhkb/README.md
index 7ea9843a678b309a3f033e99de12903c6ad58fa8..d4a2cd0223959846a0d54a6f08f8c3980cdeb90b 100644 (file)
--- a/keyboard/hhkb/README.md
+++ b/keyboard/hhkb/README.md
@@ -2,7 +2,7 @@ Alternative Controller for HHKB Pro
 ===================================
 I wanted to add some features like vi cursor and mouse keys to my [HHKB][HHKB] but its controller is not programmable and firmware source code is not open, of course. This means customizing this keyboard needs to replace original controller with programmable one.
 
-This controller can work with HHKB **Professional**, **Professional** 2 and **Type-S**.
+This controller can work with HHKB **Professional**, **Professional** 2, **JP** and **Type-S**.
 
 See [this thread][AltController] in geekhack.org.
 
@@ -43,7 +43,7 @@ See [doc/HHKB.txt](doc/HHKB.txt) and files under [doc/](doc/) for internal of HH
 See [this document](../../doc/build.md) first.
 
 ### Configuration
-Set `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`.
+Set `MCU`, `BOOTLOADER_SIZE` and other build options in `Makefile` and `config.h`. If your target is **HHKB JP** you need to set `HHKB_JP` build option in `Makefile`.
 
 ### Build 
 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. Just `make` with `KEYMAP` option like:
@@ -66,37 +66,22 @@ Use [Teensy Loader] if your controller is Teensy/Teensy++.
 
 
 ##Keymap
-To define your own keymap create file named `keymap_<name>.c` and see keymap document(you can find in top README.md) and existent keymap files.
+To define your own keymap create file named `keymap_<name>.c` and see [keymap document](../../doc/keymap.md) and existent keymap files.
 
 
 ##Hardware
 You have some options for hardware. Development boards with USB AVR family(ATMega32U4, AT90USB1286) like Teensy will work while MegaAVR with [V-USB] library is also cheaper option for DIY.
 
 ###1. TMK Alt Controller Board
-TMK designed [Keyboard Controller Board for HHKB Pro2(KiCad project)](https://github.com/tmk/HHKB_controller).
-See [this post](http://geekhack.org/index.php?topic=12047.msg948923#msg948923).
-
-
-###2. PJRC Teensy++ 2.0 version
-    +---------------+
-    |   Teensy++    |
-    |               |
-    |               |               HHKB pro    HHKB pro2
-    |               |               ~~~~~~~~    ~~~~~~~~~
-    |          PB0-2|------->ROW    (6-8)       (5-7)
-    |          PB3-5|------->COL    (9-11)      (8-10)
-    |            PB6|------->ENABLE (12)        (11)
-    |            PE6|<-------KEY    (4)         (3)
-    |            PE7|------->PREV   (5)         (4)
-    |               |
-    |               |   5V---       (1-3)       (1-2)
-    |               |  GND---       (13-14)     (12-13)
-    +---------------+
-
-- NOTE: PJRC [Teensy](http://www.pjrc.com/teensy/)
+Design files are available at [Keyboard Controller Board for HHKB(KiCad project)](https://github.com/tmk/HHKB_controller) and see [Controller Distribution thread](http://geekhack.org/index.php?topic=56494.0) if you get an assembled one.
+
+
+###2. PJRC Teensy
+See [this thread](http://geekhack.org/index.php?topic=57008.0).
+
 
 ###3. V-USB version
-See [V-USB controller for HHKB](doc/V-USB.md)
+See [V-USB controller for HHKB](doc/V-USB.md).
 
 
 [LUFA]: http://www.fourwalledcubicle.com/LUFA.php