Fixed Makefile to adjust new directories.

[max/tmk_keyboard.git] / README

diff --git a/README b/README
index 769dc318eb3d9e5a60ca1a611f756da52350d0da..d85f512c714000fd1337723fa8bc34dfa800ee21 100644 (file)
--- 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.
@@ -62,6 +80,9 @@ Copying exsistent target(macway) is easy way.
      keymaps[]
 6. Build.
 
+If you have a build error like following, comment out "--relax" option in Makefile.common.
+    (.vectors+0x30): relocation truncated to fit: R_AVR_13_PCREL against symbol `__vector_12'
+
 
 Build Options
 -------------
@@ -75,8 +96,8 @@ Build Options
 3. Choose optional modules as needed. Comment out to disable optional modules.
      MOUSEKEY_ENABLE = yes     # Mouse keys
      PS2_MOUSE_ENABLE = yes    # PS/2 mouse(TrackPoint) support
-     USB_EXTRA_ENABLE = yes    # Enhanced feature for Windows(Audio control and System control)
-     USB_NKRO_ENABLE = yes     # USB Nkey Rollover
+     EXTRAKEY_ENABLE = yes     # Enhanced feature for Windows(Audio control and System control)
+     NKRO_ENABLE = yes         # USB Nkey Rollover
 
 <target>/config.h:
 1. USB vendor/product ID and device description
@@ -97,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.