usb_usb: Add unimap

[max/tmk_keyboard.git] / converter / usb_usb / README

diff --git a/converter/usb_usb/README b/converter/usb_usb/README
index 30d5deb1e5817b1428a45721d82e85b145192eda..0a8d7993905a0b48a230d2f689c8734c8dec7df1 100644 (file)
--- a/converter/usb_usb/README
+++ b/converter/usb_usb/README
@@ -1,21 +1,31 @@
 USB to USB keyboard protocol converter
 ======================================
+See for detail and discussion.
+https://geekhack.org/index.php?topic=69169.0
+
 
 Hardware requirement
 --------------------
-Arduino Leonardo
-    http://arduino.cc/en/Main/ArduinoBoardLeonardo 
+There are two options.
+
+### TMK USB-USB Converter
+You can buy a fully assembled converter from me here.
 
-Circuit@Home USB Host Shield 2.0
+    https://geekhack.org/index.php?topic=69169.0
+
+### Arduino Leonardo + Circuit@Home USB Host Shield 2.0
+Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
+
+    http://arduino.cc/en/Main/ArduinoBoardLeonardo 
     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-2-0-for-arduino-assembled/
 
-Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be the easiest way, you won't need even soldering iron.
-Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
+Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
 
     http://arduino.cc/en/Main/ArduinoUSBHostShield
     https://www.sparkfun.com/products/9947
 
 Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
+
     https://www.circuitsathome.com/products-page/arduino-shields/usb-host-shield-for-arduino-pro-mini
     https://www.sparkfun.com/products/12587
     https://www.pjrc.com/teensy/td_libs_USBHostShield.html
@@ -24,6 +34,8 @@ Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with som
 
 Build firmware
 --------------
+Build.
+
     $ git clone git://github.com/tmk/tmk_keyboard.git
     $ cd tmk_keyboard
     $ git submodule init
@@ -31,7 +43,12 @@ Build firmware
     $ cd converter/usb_usb
     $ make
 
-Program converter. Push reset button on Leonardo before run this command. Serial port name(COM17) depends your system. On Linux I got /dev/ttyACM0.
+And Program converter. Push button on TMK converter and just run this.
+
+    $ make dfu
+
+
+In case of Leonardo push reset button then run command. Serial port name(COM17) depends your system. On Linux I got /dev/ttyACM0.
 
     $ DEV=COM17 make program
     or