README

   1 t.m.k. Keyboard Firmware
   2 ========================
   3 http://github.com/tmk/tmk_keyboard
   4
   5 This is keyboard firmware for PFU HHKB style keyboard and teensy 2.0.
   6 OS see this as composite device which has keyboard and mouse.
   7
   8 The project is heavily based on PJRC USB Keyboard/Mouse Example and
   9 owes a debt to preceding keyboard firmware projects.
  10
  11
  12 VERSION
  13 -------
  14 0.1     2010/08/23
  15         It works as normal keyboard.
  16         It is for modified Macway keyboard(TP-999KB-E).
  17
  18 1.0     2010/10/02
  19         keyboard has mouse key now.
  20         keyboard with layers.(see keymap.c)
  21             FN_1(right cmd):
  22                 vi style layer
  23             FN_2(next to right shift):
  24                 HHKB style layer
  25             FN_3(left bottom):
  26                 h j k l:   mouse move
  27                 a s d spc: mouse buttons
  28                 m ,:       mouse wheel
  29
  30
  31 target board
  32 ------------
  33 Teensy 2.0
  34 http://www.pjrc.com/teensy
  35
  36
  37 projects related
  38 ----------------
  39 PJRC USB Keyboard/Mouse Example
  40     http://www.pjrc.com/teensy/usb_keyboard.html
  41     http://www.pjrc.com/teensy/usb_mouse.html
  42 kbupgrade
  43     http://github.com/rhomann/kbupgrade
  44     http://geekhack.org/showwiki.php?title=Island:8406
  45 c64key
  46     http://symlink.dk/projects/c64key/
  47 rump
  48     http://mg8.org/rump/
  49     http://github.com/clee/rump
  50 dulcimer
  51     http://www.schatenseite.de/dulcimer.html
  52 humblehacker-keyboard
  53     http://github.com/humblehacker
  54     http://www.humblehacker.com/keyboard/
  55     http://geekhack.org/showwiki.php?title=Island:6292
  56 ps2avr
  57     http://sourceforge.net/projects/ps2avr/
  58
  59
  60 TODO
  61 ----
  62 licensing notes(GPL)
  63     I think GPL is not infringement of PJRC license.
  64 souce code cleaning
  65 sleep&wakeup
  66 debouncing
  67     will be coded when bouncing occurs.
  68     bouncing doesnt occur on my ALPS switch so far.
  69     scan rate is too slow?(to be measure)
  70 setting menu(wizard)
  71     debug console
  72     keymap setting
  73     matrix display
  74 PS/2 keyboard mode
  75 support for HHKB pro matrix signal
  76 Trackpoint(PS/2) support
  77 Thinkpad keyboard support
  78 mouse horizontal wheel
  79
  80
  81 EOF