ibm4704_usb: Add Makefiles for TMK Converter

[max/tmk_keyboard.git] / converter / ibm4704_usb / README.md

diff --git a/converter/ibm4704_usb/README.md b/converter/ibm4704_usb/README.md
index a3af4ab31dc7f96f4d3cc1632b4f4dc455b1c4bc..49c65cdfe5f2c16c3e7065a46a02fd4606d7257f 100644 (file)
--- a/converter/ibm4704_usb/README.md
+++ b/converter/ibm4704_usb/README.md
@@ -5,13 +5,21 @@ This firmware converts IBM 4704 keyboard protocol to USB HID.
 Keyboard initialization process takes a few seconds at start up. During that you will hear buzzer from the keyboard. **You need to plug USB cable after hooking up your keyboard to the converter.**
 
 
+Update
+------
+2015/09/07  Added keymap for Alps 102-key. Thanks, tai @ geekhack!
+2015/05/05  Added keymaps for 107-key, 77-key and 50-key. Thanks, orihalcon @ geekhack!
+2015/05/19  Fixed a protocol handling bug.
+
+
+
 Supported Keyboard
 ------------------
 ### IBM capacitive switch models:
-- 6019273 Model 100 50-key (grid layout)      http://kishy.dyndns.org/?p=977
-- 6019284 Model 200 62-key Alpha(60% layout)  http://kishy.dyndns.org/?p=894
-- 6019303 Model 300 77-key Expanded Alpha     http://kbtalking.cool3c.com/article/23272
-- 6020218 Model 400 107-key Full key          http://kishy.dyndns.org/?p=980
+- 6019273 Model 100 50-key (grid layout)      http://kishy.ca/?p=894
+- 6019284 Model 200 62-key Alpha(60% layout)  http://kishy.ca/?p=894
+- 6019303 Model 300 77-key Expanded Alpha     http://deskthority.net/photos-f62/ibm-6019303-t8502.html
+- 6020218 Model 400 107-key Full key          http://kishy.ca/?p=894
 
 ### Alps switch(vintage Green) models:
 
@@ -39,24 +47,39 @@ Keyboard Plug from front:
 
 Connection
 ----------
-In case of using ATMega32U4(Teensy2.0):
+In case of using ATMega32U4/U2
 
 1. Supply power with VCC and GND.
 2. Connect CLOCK to PD1 and DATA to PD0. You can change pin with config.h.
 3. Optionally you may need pull-up register. 1KOhm probably work.
 
+TMK Converter can supports IBM 4704.
+https://github.com/tmk/keyboard_converter
+
 
 Build Firmware
 --------------
 Just run `make`:
 
-    $ make
+    $ make -f <makefile>
+
+For TMK Converter rev.1 use `Makefile.tmk_rev1` as makefile:
+
+    $ make -f Makefile.tmk_rev1
+
+For TMK Converter rev.2 use `Makefile.tmk_rev2` as makefile:
+
+    $ make -f Makefile.tmk_rev2
 
 To select keymap:
 
-    $ make KEYMAP=[plain|...]
+    $ make -f <makefile> KEYMAP=[plain|...]
+
+To indentify your TMK Converter revision see [this](https://github.com/tmk/keyboard_converter#pcb-revisions).
 
 
 Keymap
 ------
 Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. 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.
+
+Use `KEYMAP_ALPS102()` to define your keymap for Alps models.