add build option USB_12KRO.

[max/tmk_keyboard.git] / README

diff --git a/README b/README
index c8d81a9c38d496c4879bae872db6ea694fce4ed6..4c19ddba3b6de0eac320bed641fc29a6e6a8f5f7 100644 (file)
--- a/README
+++ b/README
@@ -1,13 +1,15 @@
 t.m.k. Keyboard Firmware
 ========================
 t.m.k. Keyboard Firmware
 ========================

-This is keyboard firmware for PFU HHKB style keyboard and teensy 2.0.
+http://github.com/tmk/tmk_keyboard
+
+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
 owes a debt to preceding keyboard firmware projects.
 
 
 OS see this as composite device which has keyboard and mouse.
 
 The project is heavily based on PJRC USB Keyboard/Mouse Example and
 owes a debt to preceding keyboard firmware projects.
 
 

-VERSION
+Version

 -------
 0.1     2010/08/23
         It works as normal keyboard.
 -------
 0.1     2010/08/23
         It works as normal keyboard.


@@ -25,14 +27,40 @@ VERSION
                 a s d spc: mouse buttons
                 m ,:       mouse wheel
 
                 a s d spc: mouse buttons
                 m ,:       mouse wheel
 

+1.1     2010/10/08
+        Matrix wiring changed for casing.
+        (and my Teensy PD3 seems to be latchuped and unusable. :<)

 
 

-target board
-------------
-Teensy 2.0
+1.2     2010/10/13
+        HHKB support
+        horizontal mouse wheel support
+        change keymaps
+
+2.0     2010/10/27
+        HHKB/Macway support merged
+
+
+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
 
 
 http://www.pjrc.com/teensy
 
 

-projects related
+Projects related

 ----------------
 PJRC USB Keyboard/Mouse Example
     http://www.pjrc.com/teensy/usb_keyboard.html
 ----------------
 PJRC USB Keyboard/Mouse Example
     http://www.pjrc.com/teensy/usb_keyboard.html


@@ -55,25 +83,59 @@ ps2avr
     http://sourceforge.net/projects/ps2avr/
 
 
     http://sourceforge.net/projects/ps2avr/
 
 

-TODO
-----
+TODO & ideas
+------------

 licensing notes(GPL)
     I think GPL is not infringement of PJRC license.
 souce code cleaning
 sleep&wakeup
 licensing notes(GPL)
     I think GPL is not infringement of PJRC license.
 souce code cleaning
 sleep&wakeup

-debouncing
+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)
     will be coded when bouncing occurs.
     bouncing doesnt occur on my ALPS switch so far.
     scan rate is too slow?(to be measure)

-setting menu(wizard)
-    debug console
-    keymap setting
+
+Trackpoint(PS/2)
+    receive PS/2 signal from TrackPoint
+    send USB HID report
+Thinkpad keyboard support
+    turn keyboard to USB keyboard/mouse composite device
+setting menu(configure without changing firmware)
+    console for display
+    keymap/layer setting
+    mouse speed/acceleration

     matrix display
 PS/2 keyboard mode
     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
 support for HHKB pro matrix signal

-Trackpoint(PS/2) support
-Thinkpad keyboard support
+    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

 mouse horizontal wheel
 mouse horizontal wheel

-
+    http://www.microchip.com/forums/tm.aspx?high=&m=391435&mpage=1#391521
+    http://www.keil.com/forum/15671/
+    http://www.microsoft.com/whdc/device/input/wheel.mspx
+    2010/10/13
+debug on/off
+    Fn key conbination during normal operation
+    matrix print on/off
+    key print on/off
+    mouse print on/off
+    2010/10/26
+layer switching
+    time before switching
+    timeout when not used during specific time
+    2010/10/30

 
 EOF
 
 EOF