aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md67
-rw-r--r--converter/news_usb/Makefile.pjrc (renamed from converter/sony_usb/Makefile.pjrc)0
-rw-r--r--converter/news_usb/config_pjrc.h (renamed from converter/sony_usb/config_pjrc.h)0
-rw-r--r--converter/news_usb/keymap.c (renamed from converter/sony_usb/keymap.c)0
-rw-r--r--converter/news_usb/led.c (renamed from converter/sony_usb/led.c)0
-rw-r--r--converter/news_usb/matrix.c (renamed from converter/sony_usb/matrix.c)0
-rw-r--r--keyboard/hbkb/Makefile (renamed from keyboard/hbk/Makefile)0
-rw-r--r--keyboard/hbkb/config.h (renamed from keyboard/hbk/config.h)0
-rw-r--r--keyboard/hbkb/controller_teensy.h (renamed from keyboard/hbk/controller_teensy.h)0
-rw-r--r--keyboard/hbkb/keymap.c (renamed from keyboard/hbk/keymap.c)0
-rw-r--r--keyboard/hbkb/led.c (renamed from keyboard/hbk/led.c)0
-rw-r--r--keyboard/hbkb/matrix.c (renamed from keyboard/hbk/matrix.c)0
-rw-r--r--protocol/news.c (renamed from converter/sony_usb/news.c)0
-rw-r--r--protocol/news.h (renamed from converter/sony_usb/news.h)0
-rw-r--r--protocol/x68k.c (renamed from converter/x68k_usb/x68k.c)0
-rw-r--r--protocol/x68k.h (renamed from converter/x68k_usb/x68k.h)0
16 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
Projects
--------
### converter
-* ps2_usb - PS/2 keyboard to USB
-* adb_usb - ADB keyboard to USB
-* m0110_usb - Machintosh 128K/512K/Plus keyboard to USB
-* terminal_usb - IBM Model M terminal keyboard(PS/2 scancode set3) to USB
-* sony_usb - Sony NEWS keyboard to USB
-* x68k_usb - Sharp X68000 keyboard to USB
+* [ps2_usb][c1] - [PS/2 keyboard to USB][GH_ps2]
+* [adb_usb][c2] - [ADB keyboard to USB][GH_adb]
+* [m0110_usb][c3] - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
+* [terminal_usb][c4] - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
+* [news_usb][c5] - [Sony NEWS keyboard to USB][GH_news]
+* [x68k_usb][c6] - [Sharp X68000 keyboard to USB][GH_x68k]
### keyboard
-* hhkb - Happy Hacking Keyboard professional
-* macway - Compact keyboard mod
-* hbk - Happy Buckling sprint keyboard(IBM Model M mod)
-
+* [hhkb][k1] - [Happy Hacking Keyboard professional][GH_hhkb]
+* [macway][k2] - [Compact keyboard mod][GH_macway]
+* [hbkb][k3] - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
+
+[c1]: converter/ps2_usb/
+[c2]: converter/adb_usb/
+[c3]: converter/m0110_usb/
+[c4]: converter/terminal_usb/
+[c5]: converter/news_usb/
+[c6]: converter/x68k_usb/
+[k1]: keyboard/hhkb
+[k2]: keyboard/macway
+[k3]: keyboard/hbkb
[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
-[GH_sony]: http://geekhack.org/showwiki.php?title=Island:25759
+[GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
-[GH_hbk]: http://geekhack.org/showwiki.php?title=Island:29483
+[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
Files & Directories
-------------------
### Top
-* common/ common codes
-* protocol/ keyboard protocol support
-* keyboard/ keyboard projects
-* converter/ protocol converter projects
-* doc/ documents
+* [common/](common/) - common codes
+* [protocol/](protocol/) - keyboard protocol support
+* [keyboard/](keyboard/) - keyboard projects
+* [converter/](converter/) - protocol converter projects
+* [doc/](doc/) - documents
### Keyboard Protocols
-* pjrc/ PJRC USB stack
-* vusb/ Objective Development V-USB
-* iwrap/ Bluetooth HID for Bluegiga iWRAP
-* ps2 PS/2 protocol
-* adb Apple Desktop Bus protocol
-* m0110 Macintosh 128K/512K/Plus keyboard protocol
-* news Sony NEWS keyboard protocol
-* x68k Sharp X68000 keyboard protocol
+* [pjrc/](protocol/pjrc/) - PJRC USB stack
+* [vusb/](protocol/vusb/) - Objective Development V-USB
+* [iwrap/](protocol/iwrap) - Bluetooth HID for Bluegiga iWRAP
+* [ps2.c](protocol/ps2.c) - PS/2 protocol
+* [adb.c](protocol/adb.c) - Apple Desktop Bus protocol
+* [m0110.c](protocol/m0110.c) - Macintosh 128K/512K/Plus keyboard protocol
+* [news.c](protocol/news.c) - Sony NEWS keyboard protocol
+* [x68k.c](protocol/x68k.c) - Sharp X68000 keyboard protocol
Build & Program
---------------
### Build firmware
To compile you need `AVR GCC`, `AVR Libc` and `GNU make`.
-You can use [WinAVR][1] on Windows and [CrossPack][2] on Mac.
+You can use [WinAVR][winavr] on Windows and [CrossPack][crosspack] on Mac.
$ cd <project>
$ make
-The firmware will be compiled as a file tmk_<project>.hex.
+The firmware will be compiled as a file `tmk_<project>.hex`.
-[1]: http://winavr.sourceforge.net/
-[2]: http://www.obdev.at/products/crosspack/index.html
+[winavr]: http://winavr.sourceforge.net/
+[crosspack]: http://www.obdev.at/products/crosspack/index.html
### Program Controller
If you have proper program command in Makefile just type this.
diff --git a/converter/sony_usb/Makefile.pjrc b/converter/news_usb/Makefile.pjrc
index 376133ad5..376133ad5 100644
--- a/converter/sony_usb/Makefile.pjrc
+++ b/converter/news_usb/Makefile.pjrc
diff --git a/converter/sony_usb/config_pjrc.h b/converter/news_usb/config_pjrc.h
index e9cf7dedb..e9cf7dedb 100644
--- a/converter/sony_usb/config_pjrc.h
+++ b/converter/news_usb/config_pjrc.h
diff --git a/converter/sony_usb/keymap.c b/converter/news_usb/keymap.c
index 4bd556ba0..4bd556ba0 100644
--- a/converter/sony_usb/keymap.c
+++ b/converter/news_usb/keymap.c
diff --git a/converter/sony_usb/led.c b/converter/news_usb/led.c
index 51e601318..51e601318 100644
--- a/converter/sony_usb/led.c
+++ b/converter/news_usb/led.c
diff --git a/converter/sony_usb/matrix.c b/converter/news_usb/matrix.c
index bf363e7d9..bf363e7d9 100644
--- a/converter/sony_usb/matrix.c
+++ b/converter/news_usb/matrix.c
diff --git a/keyboard/hbk/Makefile b/keyboard/hbkb/Makefile
index 26be322e0..26be322e0 100644
--- a/keyboard/hbk/Makefile
+++ b/keyboard/hbkb/Makefile
diff --git a/keyboard/hbk/config.h b/keyboard/hbkb/config.h
index 5262399dc..5262399dc 100644
--- a/keyboard/hbk/config.h
+++ b/keyboard/hbkb/config.h
diff --git a/keyboard/hbk/controller_teensy.h b/keyboard/hbkb/controller_teensy.h
index 1b1611365..1b1611365 100644
--- a/keyboard/hbk/controller_teensy.h
+++ b/keyboard/hbkb/controller_teensy.h
diff --git a/keyboard/hbk/keymap.c b/keyboard/hbkb/keymap.c
index 1de317c9a..1de317c9a 100644
--- a/keyboard/hbk/keymap.c
+++ b/keyboard/hbkb/keymap.c
diff --git a/keyboard/hbk/led.c b/keyboard/hbkb/led.c
index fc0eeb0ff..fc0eeb0ff 100644
--- a/keyboard/hbk/led.c
+++ b/keyboard/hbkb/led.c
diff --git a/keyboard/hbk/matrix.c b/keyboard/hbkb/matrix.c
index d7c066364..d7c066364 100644
--- a/keyboard/hbk/matrix.c
+++ b/keyboard/hbkb/matrix.c
diff --git a/converter/sony_usb/news.c b/protocol/news.c
index d18b996f4..d18b996f4 100644
--- a/converter/sony_usb/news.c
+++ b/protocol/news.c
diff --git a/converter/sony_usb/news.h b/protocol/news.h
index 35e09c4d2..35e09c4d2 100644
--- a/converter/sony_usb/news.h
+++ b/protocol/news.h
diff --git a/converter/x68k_usb/x68k.c b/protocol/x68k.c
index d17af51cc..d17af51cc 100644
--- a/converter/x68k_usb/x68k.c
+++ b/protocol/x68k.c
diff --git a/converter/x68k_usb/x68k.h b/protocol/x68k.h
index 2cfda63a7..2cfda63a7 100644
--- a/converter/x68k_usb/x68k.h
+++ b/protocol/x68k.h