aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md67
1 files changed, 38 insertions, 29 deletions
diff --git a/README.md b/README.md
index 0361e2ad9..d6d8fb4ec 100644
--- a/README.md
+++ b/README.md
@@ -17,64 +17,73 @@ Features
17Projects 17Projects
18-------- 18--------
19### converter 19### converter
20* ps2_usb - PS/2 keyboard to USB 20* [ps2_usb][c1] - [PS/2 keyboard to USB][GH_ps2]
21* adb_usb - ADB keyboard to USB 21* [adb_usb][c2] - [ADB keyboard to USB][GH_adb]
22* m0110_usb - Machintosh 128K/512K/Plus keyboard to USB 22* [m0110_usb][c3] - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
23* terminal_usb - IBM Model M terminal keyboard(PS/2 scancode set3) to USB 23* [terminal_usb][c4] - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
24* sony_usb - Sony NEWS keyboard to USB 24* [news_usb][c5] - [Sony NEWS keyboard to USB][GH_news]
25* x68k_usb - Sharp X68000 keyboard to USB 25* [x68k_usb][c6] - [Sharp X68000 keyboard to USB][GH_x68k]
26 26
27### keyboard 27### keyboard
28* hhkb - Happy Hacking Keyboard professional 28* [hhkb][k1] - [Happy Hacking Keyboard professional][GH_hhkb]
29* macway - Compact keyboard mod 29* [macway][k2] - [Compact keyboard mod][GH_macway]
30* hbk - Happy Buckling sprint keyboard(IBM Model M mod) 30* [hbkb][k3] - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
31 31
32[c1]: converter/ps2_usb/
33[c2]: converter/adb_usb/
34[c3]: converter/m0110_usb/
35[c4]: converter/terminal_usb/
36[c5]: converter/news_usb/
37[c6]: converter/x68k_usb/
38[k1]: keyboard/hhkb
39[k2]: keyboard/macway
40[k3]: keyboard/hbkb
32[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930 41[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
33[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047 42[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
34[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618 43[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
35[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290 44[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
36[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851 45[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
37[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965 46[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
38[GH_sony]: http://geekhack.org/showwiki.php?title=Island:25759 47[GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
39[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272 48[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
40[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060 49[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
41[GH_hbk]: http://geekhack.org/showwiki.php?title=Island:29483 50[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
42 51
43 52
44 53
45Files & Directories 54Files & Directories
46------------------- 55-------------------
47### Top 56### Top
48* common/ common codes 57* [common/](common/) - common codes
49* protocol/ keyboard protocol support 58* [protocol/](protocol/) - keyboard protocol support
50* keyboard/ keyboard projects 59* [keyboard/](keyboard/) - keyboard projects
51* converter/ protocol converter projects 60* [converter/](converter/) - protocol converter projects
52* doc/ documents 61* [doc/](doc/) - documents
53 62
54### Keyboard Protocols 63### Keyboard Protocols
55* pjrc/ PJRC USB stack 64* [pjrc/](protocol/pjrc/) - PJRC USB stack
56* vusb/ Objective Development V-USB 65* [vusb/](protocol/vusb/) - Objective Development V-USB
57* iwrap/ Bluetooth HID for Bluegiga iWRAP 66* [iwrap/](protocol/iwrap) - Bluetooth HID for Bluegiga iWRAP
58* ps2 PS/2 protocol 67* [ps2.c](protocol/ps2.c) - PS/2 protocol
59* adb Apple Desktop Bus protocol 68* [adb.c](protocol/adb.c) - Apple Desktop Bus protocol
60* m0110 Macintosh 128K/512K/Plus keyboard protocol 69* [m0110.c](protocol/m0110.c) - Macintosh 128K/512K/Plus keyboard protocol
61* news Sony NEWS keyboard protocol 70* [news.c](protocol/news.c) - Sony NEWS keyboard protocol
62* x68k Sharp X68000 keyboard protocol 71* [x68k.c](protocol/x68k.c) - Sharp X68000 keyboard protocol
63 72
64 73
65Build & Program 74Build & Program
66--------------- 75---------------
67### Build firmware 76### Build firmware
68To compile you need `AVR GCC`, `AVR Libc` and `GNU make`. 77To compile you need `AVR GCC`, `AVR Libc` and `GNU make`.
69You can use [WinAVR][1] on Windows and [CrossPack][2] on Mac. 78You can use [WinAVR][winavr] on Windows and [CrossPack][crosspack] on Mac.
70 79
71 $ cd <project> 80 $ cd <project>
72 $ make 81 $ make
73 82
74The firmware will be compiled as a file tmk_<project>.hex. 83The firmware will be compiled as a file `tmk_<project>.hex`.
75 84
76[1]: http://winavr.sourceforge.net/ 85[winavr]: http://winavr.sourceforge.net/
77[2]: http://www.obdev.at/products/crosspack/index.html 86[crosspack]: http://www.obdev.at/products/crosspack/index.html
78 87
79### Program Controller 88### Program Controller
80If you have proper program command in Makefile just type this. 89If you have proper program command in Makefile just type this.