README

   1 t.m.k. Keyboard Firmware
   2 ========================
   3 http://github.com/tmk/tmk_keyboard
   4
   5 This is keyboard firmware for AVR USB MCUs or Teensy/Teensy++ 2.0.
   6
   7 The project is heavily based on PJRC USB Keyboard/Mouse Example and
   8 owes a debt to preceding keyboard firmware projects.
   9
  10 http://www.pjrc.com/teensy
  11
  12
  13
  14 Functions
  15 ---------
  16 Mouse key
  17 System Control Key
  18     Power Down, Sleep, Wake Up & USB Remote Wake up
  19 Media Control Key
  20     Volume Down/Up, Mute
  21 USB NKRO
  22
  23
  24 Build
  25 -----
  26 Compiling sources need AVR GCC, AVR Libc and GNU make.(You can use WinAVR on Windows.)
  27
  28 $ cd <target> (hhkb or macway)
  29 $ make
  30
  31 http://winavr.sourceforge.net/
  32
  33
  34 Debuging & Rescue
  35 -----------------
  36 Use PJRC's hid_listen.exe to see debug messages.
  37 Press right Control + Shift + Alt + GUI + H to debug menu.
  38
  39 Pressing any 3 keys when connected enables debug output.
  40 Pressing any 4 keys when connected makes bootloader comes up.
  41
  42
  43 Projects related
  44 ----------------
  45 PJRC USB Keyboard/Mouse Example
  46     http://www.pjrc.com/teensy/usb_keyboard.html
  47     http://www.pjrc.com/teensy/usb_mouse.html
  48 kbupgrade
  49     http://github.com/rhomann/kbupgrade
  50     http://geekhack.org/showwiki.php?title=Island:8406
  51 c64key
  52     http://symlink.dk/projects/c64key/
  53 rump
  54     http://mg8.org/rump/
  55     http://github.com/clee/rump
  56 dulcimer
  57     http://www.schatenseite.de/dulcimer.html
  58 humblehacker-keyboard
  59     http://github.com/humblehacker
  60     http://www.humblehacker.com/keyboard/
  61     http://geekhack.org/showwiki.php?title=Island:6292
  62 ps2avr
  63     http://sourceforge.net/projects/ps2avr/
  64
  65
  66 EOF