Update XT converter readme.
[tmk_keyboard.git] / converter / xt_usb / README.md
1 XT to USB keyboard converter
2 ==============================
3 This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.)
4
5
6 Connect Wires
7 -------------
8 In case of Teensy2.0(ATMega32U4):
9
10 1. Connect **Vcc** and **GND**.
11 2. Connect **Clock** and **Data** line.
12 - **Interrupt**: **Clock** is on `PD1` and **Data** on `PD0`.(Recommended. Soarer's converter compatible)
13 3. Optionally you need pull-up resistor. 1K-10K Ohm is OK.
14
15 To change pin configuration edit **config.h** and **Makefile**.
16
17
18 Build Firmware
19 --------------
20 For **PJRC Teensy** just run `make`:
21
22 $ make clean
23 $ make
24
25 To select keymap:
26
27 $ make clean
28 $ make KEYMAP=[plain|jis|spacefn|...]
29
30 After that you will find HEX file `xt_usb_lufa.hex` in current directory.
31
32
33 Keymap
34 ------
35 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.
36
Imprint / Impressum