summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authortmk <nobody@nowhere>2011-02-22 02:57:01 +0900
committertmk <nobody@nowhere>2011-02-22 03:49:02 +0900
commit00350c180dee31ec9d9c4aee31e06faf55bd1c6b (patch)
treed54b35ca96ec6bce6c415423cdba4f66d198b433 /README
parentd2b9489a5e19fabb5d6ec285192b19dc25b36d5e (diff)
downloadqmk_firmware-00350c180dee31ec9d9c4aee31e06faf55bd1c6b.tar.gz
qmk_firmware-00350c180dee31ec9d9c4aee31e06faf55bd1c6b.zip
v3.0 cleanse files
Diffstat (limited to 'README')
-rw-r--r--README35
1 files changed, 27 insertions, 8 deletions
diff --git a/README b/README
index 3361c1f99b..2aa0106b06 100644
--- a/README
+++ b/README
@@ -1,16 +1,19 @@
t.m.k. Keyboard Firmware
========================
-http://github.com/tmk/tmk_keyboard
-
-This is keyboard firmware for AVR USB MCUs or Teensy/Teensy++.
-http://www.pjrc.com/teensy
+This is keyboard firmware for Teensy(AVR USB MCU) and V-USB board.
-The project is heavily based on PJRC USB Keyboard/Mouse Example and
-owes a debt to preceding keyboard firmware projects.
+source code repository:
+http://github.com/tmk/tmk_keyboard
This firmware is used in following projects:
HHKB mod: http://geekhack.org/showwiki.php?title=Island:12047
Macway mod: http://geekhack.org/showwiki.php?title=Island:11930
+PS2 to USB: http://geekhack.org/showwiki.php?title=Island:14618
+ADB to USB: http://geekhack.org/showwiki.php?title=Island:14290
+
+The project is heavily based on PJRC USB Keyboard/Mouse Example and
+owes a debt to preceding keyboard firmware projects.
+http://www.pjrc.com/teensy
Features
@@ -31,12 +34,27 @@ Limitations
-----------
+Files & Directories
+-------------------
+Target:
+hhkb/ keyboard controller for PFU HHKB pro
+macway/ keyboard controller for Macway mod
+ps2_usb/ PS2 to USB keyboard converter
+adb_usb/ ADB to USB keyboard converter
+
+USB Protocol Stack:
+pjrc/ PJRC USB stack
+vusb/ V-USB USB stack
+ps2.[ch] PS/2 protocol
+adb.[ch] ADB protocol
+
+
Build
-----
To compile needs AVR GCC, AVR Libc and GNU make.
You can use WinAVR on Windows. http://winavr.sourceforge.net/
-$ cd <target> (hhkb or macway currently)
+$ cd <target>
$ make
The firmware will be compiled as a file tmk_<target>.hex.
@@ -100,7 +118,8 @@ Build Options
Debuging & Rescue
-----------------
Use PJRC's hid_listen.exe to see debug messages.
-Press right Control + Shift + Alt + GUI + H to debug menu.
+Press <COMMAND> + H to debug menu.
+(see config.h for <COMMAND> key combination.)
Pressing any 3 keys when connected enables debug output.
Pressing any 4 keys when connected makes bootloader comes up.