]> git.friedersdorff.com Git - max/tmk_keyboard.git/commitdiff
xt_usb: Update README
authortmk <hasu@tmk-kbd.com>
Tue, 24 Apr 2018 17:57:29 +0000 (02:57 +0900)
committertmk <hasu@tmk-kbd.com>
Tue, 24 Apr 2018 17:57:29 +0000 (02:57 +0900)
converter/xt_usb/README.md

index b9641a03bc219aeab405631b82aa555829ab4226..5f4f5601fca36763bf0255dceb65c4ba2aed5d43 100644 (file)
@@ -5,32 +5,30 @@ This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.
 
 Connect Wires
 -------------
-In case of Teensy2.0(ATMega32U4):
-
 1. Connect **Vcc** and **GND**.
-2. Connect **Clock** and **Data** line. 
-    - **Interrupt**:   **Clock** is on `PD1` and **Data** on `PD0`.(Recommended. Soarer's converter compatible)
-3. Optionally you need pull-up resistor. 1K-10K Ohm is OK.
+2. Connect **Clock** and **Data** line. **Clock** is on `PD1`,  **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`.
+3. You need pull-up resistor. **1K-10K Ohm** will be OK.
 
-To change pin configuration edit **config.h** and **Makefile**.
 
 
 Build Firmware
 --------------
-For **PJRC Teensy** just run `make`:
+Just run `make`:
 
     $ make clean
     $ make
 
-To select keymap:
+To use your own keymap create `keymap_<name>.c` file and then:
 
     $ make clean
-    $ make KEYMAP=[plain|jis|spacefn|...]
+    $ make KEYMAP=<name>
+
+After that you will find HEX file `xt_usb.hex` in current directory.
 
-After that you will find HEX file `xt_usb_lufa.hex` in current directory.
 
+See wiki pages on github for further information.  https://github.com/tmk/tmk_keyboard/wiki
 
-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 README.md of top directory) and existent keymap files.
 
+XT keyboard protocol  resource
+------------------------------
+https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol