ADD: keymap macro for human to read easier

[max/tmk_keyboard.git] / README

diff --git a/README b/README
index 1dc82ae22ddad9468ae59048e05790b0e21c2381..9bc883410e5333549c6ee84210b23bed3baee886 100644 (file)
--- a/README
+++ b/README
@@ -2,7 +2,7 @@ t.m.k. Keyboard Firmware
 ========================
 http://github.com/tmk/tmk_keyboard
 
-This is keyboard firmware for PFU HHKB style keyboard and teensy 2.0.
+This is keyboard firmware for PFU HHKB style keyboard and Teensy/Teensy++ 2.0.
 OS see this as composite device which has keyboard and mouse.
 
 The project is heavily based on PJRC USB Keyboard/Mouse Example and
@@ -31,10 +31,29 @@ Version
         Matrix wiring changed for casing.
         (and my Teensy PD3 seems to be latchuped and unusable. :<)
 
+1.2     2010/10/13
+        HHKB support
+        horizontal mouse wheel support
+        change keymaps
 
-Target board
-------------
-Teensy 2.0
+
+Build
+-----
+Compiling sources need AVR GCC, AVR Libc and GNU make.(You can use WinAVR on Windows.)
+
+$ cd <target> (hhkb or macway)
+$ make
+
+
+Debuging
+--------
+Debug print is on if 4 keys are pressed during booting. 
+Use PJRC's hid_listen.exe to see debug messages.
+
+
+AVR Target board
+----------------
+Teensy/Teensy++
 http://www.pjrc.com/teensy
 
 
@@ -71,9 +90,15 @@ debouncing logic
     will be coded when bouncing occurs.
     bouncing doesnt occur on my ALPS switch so far.
     scan rate is too slow?(to be measure)
+layer switching
+    time before switching
+    timeout when not used during specific time
+debug on/off
+    Fn key conbination during normal operation
+    matrix print on/off
+    key print on/off
+    mouse print on/off
 
-support for HHKB pro matrix signal
-    exchange controller board with teensy
 Trackpoint(PS/2)
     receive PS/2 signal from TrackPoint
     send USB HID report
@@ -90,6 +115,22 @@ setting menu(configure without changing firmware)
     matrix display
 PS/2 keyboard mode
     with USB to PS/2 dumb adapter(possible?)
+AT90USBKEY support
+    and other AVR USB boards
+
+DONE:
+support for HHKB pro matrix signal
+    exchange controller board with teensy
+    2010/10/11
+keymap
+    Matias half keyboard style
+    2010/10/23
+souce code cleaning
+    2010/10/23
+debug on/off
+    debug off by default
+    pressing keys during booting
+    2010/10/23
 
 
 EOF