m0110: Add support for international keyboard

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

diff --git a/converter/m0110_usb/README.md b/converter/m0110_usb/README.md
index 7de36d5de146455fbf7b9ffc3f5c444ac201b3cc..22a8eb044d521f35783fbcca353a197a90e5b57a 100644 (file)
--- a/converter/m0110_usb/README.md
+++ b/converter/m0110_usb/README.md
@@ -1,6 +1,6 @@
 M0110/M0110A to USB keyboard converter
 ======================================
-This firmware converts the protocol of Apple Macintosh keyboard **M0110**, **M0110A** and **M0120** into USB. Target of this project is USB AVR controller **ATmega32U4**. Using this converter you can revive these retro keyboards with modern computer.
+This firmware converts the protocol of Apple Macintosh keyboard **M0110**, **M0110A** and **M0120** into USB. Target of this project is USB AVR controller like **ATmega32U2** and **ATmega32U4**. Using this converter you can revive these retro keyboards with modern computer.
 
 Read README of top directory too.
 
@@ -20,12 +20,13 @@ Update
 - 2013/08: Change port for signals `PF` to `PD`
 - 2013/09: Change port again, it uses inversely `PD0` for data and `PD1` for clock line now.
 - 2014/06: Change keymaps
+- 2015/03: Add support for "International"(ISO) keyboard(keymap_intl.c)
 
 
 
 Building Hardware
 -----------------
-You need **4P4C** cable and **ATMega32U4** board like PJRC [Teensy]. Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`.
+You need [TMK converter] or AVR dev board like PJRC [Teensy]. Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`.
 
 [![M0110 Converter](http://i.imgur.com/4G2ZOegm.jpg)](http://i.imgur.com/4G2ZOeg.jpg)
 
@@ -38,6 +39,7 @@ Close-up picture of handset cable. You can see one end of plug has reverse color
 [![4P4C cable](http://i.imgur.com/3S9P1mYm.jpg?1)](http://i.imgur.com/3S9P1mY.jpg?1)
 
 [Teensy]: http://www.pjrc.com/teensy/
+[TMK converter]: https://github.com/tmk/keyboard_converter
 
 
 ### Socket Pinout
@@ -53,17 +55,14 @@ You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular wh
 
 Building Firmware
 -----------------
-To compile firmware you need AVR GCC. You can edit *Makefile* and *config.h* to change compile options and pin configuration.
+To compile firmware you need AVR GCC. You can edit *Makefile* and *config.h* to change compile options and pin configuration. Also `KEYMAP` option can be used to select keymap.
 
     $ git clone git://github.com/tmk/tmk_keyboard.git (or download source)
     $ cd m0110_usb
-    $ make clean
-    $ make
+    $ make -f Makefile clean
+    $ make -f Makefile [KEYMAP={default|plain|intl|spacefn|hasu}]
 
-To select keymap use `KEYMAP` option.
-
-    $ make clean
-    $ make KEYMAP={plain|spacefn|hasu}
+Use `Makefile.teensy` instead for Teensy.
 
 
 
@@ -71,8 +70,8 @@ Keymap
 ------
 To create your own keymap copy existent keymap file to `keymap_name.c` and edit it. You can build it like this.
 
-    $ make clean
-    $ make KEYMAP=name
+    $ make -f Makefile clean
+    $ make -f Makefile KEYMAP=name