ibmpc_usb: Update prebuilt firmware hex files

[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..668c85269b0c4dffdf935227c20330e0abab7edc 100644 (file)
--- a/converter/m0110_usb/README.md
+++ b/converter/m0110_usb/README.md
@@ -1,10 +1,10 @@
 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.
 
-Pictures of **M0110 + M0120** and **M0110A**.
+Pictures of **M0110 + M0120** and **M0110A** with [TMK converter].
 
 ![M0110+M0120](http://i.imgur.com/dyvXb2Tm.jpg)
 ![M0110A](http://i.imgur.com/HuHOEoHm.jpg)
@@ -20,24 +20,26 @@ 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)
+- 2016/09: Unimap support - keymap editor on web browser
 
 
 
-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`.
+Hardware
+--------
+You can buy preassembled [TMK converter] or make yourown with 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)
+[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg)
 
 ### 4P4C phone handset cable
 Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
 
 <http://en.wikipedia.org/wiki/Modular_connector#4P4C>
 
-Close-up picture of handset cable. You can see one end of plug has reverse color codes against the other. Click to enlarge.
-[![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://geekhack.org/index.php?topic=72052.0
 
 
 ### Socket Pinout
@@ -53,31 +55,28 @@ 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
-
-To select keymap use `KEYMAP` option.
+    $ make -f Makefile.rev2 clean
+    $ make -f Makefile.rev2 [KEYMAP={intl|spacefn}]
 
-    $ make clean
-    $ make KEYMAP={plain|spacefn|hasu}
+Use `Maefile.rev1` for TMK converter rev.1 and Teensy(ATMega32u4), instead.
 
 
 
 Keymap
 ------
-To create your own keymap copy existent keymap file to `keymap_name.c` and edit it. You can build it like this.
+To create your own keymap copy existent keymap file to `keymap_<name>.c` and edit it. You can build with `make -f Makefile.rev2 KEYMAP=<name>`.
 
-    $ make clean
-    $ make KEYMAP=name
+Or you can edit keymap on web browser and download firmware.
 
+http://www.tmk-kbd.com/tmk_keyboard/editor/
 
 
 Debug
 -----
-You can use [PJRC HID listen](http://www.pjrc.com/teensy/hid_listen.html) to see debug output. The converter has some functions for debug, press `<Command>+H` simultaneously to get help.
+You can use [PJRC HID listen](http://www.pjrc.com/teensy/hid_listen.html) to see debug output. The converter has some functions for debug, press `<Magic>+H` simultaneously to get help.
 
-- Command: `Shift+Option+Command`(`Shift+Alt+Gui` or `Shift+Alt+Control`)
+- Magic combo: `Shift+Option+⌘` or `Shift+Option+Ctrl`(`Shift+Alt+Gui` or `Shift+Alt+Control`)