Merge commit '657d9f23fe47fb88cf221adb23095082f191ba6a'

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

diff --git a/converter/ibm4704_usb/README.md b/converter/ibm4704_usb/README.md
index 15c826ab8b7f7a26afc7c75f636731c34c0f40d5..45b1f683454168313e4d8da6a6397cb18fa6746e 100644 (file)
--- a/converter/ibm4704_usb/README.md
+++ b/converter/ibm4704_usb/README.md
@@ -7,8 +7,9 @@ Keyboard initialization process takes a few seconds at start up. During that you
 
 Update
 ------
 
 Update
 ------

-2015/05/05  Added keymaps for 107-key, 77-key and 50-key. Thanks, orihalcon @ geekhack!
-2015/05/19  Fixed a protocol handling bug.
+- 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.

 
 
 
 
 
 


@@ -46,24 +47,39 @@ Keyboard Plug from front:
 
 Connection
 ----------
 
 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.
 
 
 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`:
 
 
 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:
 
 
 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.
 
 
 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.