make input ports(PE6,7) *with pullup*.

[max/tmk_keyboard.git] / README

diff --git a/README b/README
index 228120cced508461046b99b8797e3dc1dd657ca9..1dc82ae22ddad9468ae59048e05790b0e21c2381 100644 (file)
--- a/README
+++ b/README
@@ -1,44 +1,48 @@
-Keyboard Firmware
-=================
-2010/08/23 noname
+t.m.k. Keyboard Firmware
+========================
+http://github.com/tmk/tmk_keyboard
 
+This is keyboard firmware for PFU HHKB style keyboard and teensy 2.0.
+OS see this as composite device which has keyboard and mouse.
 
-VERSION
+The project is heavily based on PJRC USB Keyboard/Mouse Example and
+owes a debt to preceding keyboard firmware projects.
+
+
+Version
 -------
 0.1     2010/08/23
-        implemented for macway modified.
-        It works as normal keyboard now.
-
-
-TODO
-----
-modulization
-    clean source
-debouncing
-anti-ghost
-keymap layer
-    key combination switch
-    toggle siwtch
-    HHKB like cursor etc.
-setting menu(wizard)
-    debug console
-    keymap setting
-    matrix display
-HHKB support
-Trackpoint(PS/2) support
-    Thinkpad keyboard support
+        It works as normal keyboard.
+        It is for modified Macway keyboard(TP-999KB-E).
+
+1.0     2010/10/02
+        keyboard has mouse key now.
+        keyboard with layers.(see keymap.c)
+            FN_1(right cmd):
+                vi style layer
+            FN_2(next to right shift):
+                HHKB style layer
+            FN_3(left bottom):
+                h j k l:   mouse move
+                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
+Target board
 ------------
 Teensy 2.0
 http://www.pjrc.com/teensy
 
 
-projects based on/related to
-----------------------------
-PJRC USB Keyboard Example
+Projects related
+----------------
+PJRC USB Keyboard/Mouse Example
     http://www.pjrc.com/teensy/usb_keyboard.html
+    http://www.pjrc.com/teensy/usb_mouse.html
 kbupgrade
     http://github.com/rhomann/kbupgrade
     http://geekhack.org/showwiki.php?title=Island:8406
@@ -57,4 +61,35 @@ ps2avr
     http://sourceforge.net/projects/ps2avr/
 
 
+TODO & ideas
+------------
+licensing notes(GPL)
+    I think GPL is not infringement of PJRC license.
+souce code cleaning
+sleep&wakeup
+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)
+
+support for HHKB pro matrix signal
+    exchange controller board with teensy
+Trackpoint(PS/2)
+    receive PS/2 signal from TrackPoint
+    send USB HID report
+Thinkpad keyboard support
+    turn keyboard to USB keyboard/mouse composite device
+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
+setting menu(configure without changing firmware)
+    console for display
+    keymap/layer setting
+    mouse speed/acceleration
+    matrix display
+PS/2 keyboard mode
+    with USB to PS/2 dumb adapter(possible?)
+
+
 EOF