aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortmk <nobody@nowhere>2012-06-11 15:20:40 +0900
committertmk <nobody@nowhere>2012-06-11 15:20:40 +0900
commit784c6e39795edd86e368e601f3c2e367a758c69f (patch)
treeace0d8507e8a2bb2d127b0baef95ab5694b1b128 /README.md
parent62d1ebb91c7b381ce3d88aad9ee0b03bea9fce26 (diff)
downloadqmk_firmware-784c6e39795edd86e368e601f3c2e367a758c69f.tar.gz
qmk_firmware-784c6e39795edd86e368e601f3c2e367a758c69f.zip
Fix README.md: remove bad links
Diffstat (limited to 'README.md')
-rw-r--r--README.md100
1 files changed, 51 insertions, 49 deletions
diff --git a/README.md b/README.md
index d6d8fb4ec..65fc72f53 100644
--- a/README.md
+++ b/README.md
@@ -7,37 +7,29 @@ Source code is available here: <http://github.com/tmk/tmk_keyboard>
7 7
8Features 8Features
9-------- 9--------
10* Mouse key - Mouse control by keyboard 10* Mouse key - Mouse control by keyboard.
11* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up 11* System Control Key - Power Down, Sleep, Wake Up and USB Remote Wake up.
12* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc. 12* Media Control Key - Volume Down/Up, Mute, Next/Prev track, Play, Stop and etc.
13* USB NKRO - Can send 120 keys(+ 8 modifiers) simultaneously. 13* USB NKRO - Can send 120 keys(+ 8 modifiers) simultaneously.
14* PS/2 mouse support - integrate PS/2 mouse(TrackPoint) into keyboard as composite device. 14* PS/2 mouse support - integrate PS/2 mouse(TrackPoint) into keyboard as composite device.
15* keyboard protocols - PS/2, ADB and old keyboard protocols.
15 16
16 17
17Projects 18Projects
18-------- 19--------
19### converter 20### converter
20* [ps2_usb][c1] - [PS/2 keyboard to USB][GH_ps2] 21* ps2_usb - [PS/2 keyboard to USB][GH_ps2]
21* [adb_usb][c2] - [ADB keyboard to USB][GH_adb] 22* adb_usb - [ADB keyboard to USB][GH_adb]
22* [m0110_usb][c3] - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110] 23* m0110_usb - [Machintosh 128K/512K/Plus keyboard to USB][GH_m0110]
23* [terminal_usb][c4] - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal] 24* terminal_usb - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
24* [news_usb][c5] - [Sony NEWS keyboard to USB][GH_news] 25* news_usb - [Sony NEWS keyboard to USB][GH_news]
25* [x68k_usb][c6] - [Sharp X68000 keyboard to USB][GH_x68k] 26* x68k_usb - [Sharp X68000 keyboard to USB][GH_x68k]
26 27
27### keyboard 28### keyboard
28* [hhkb][k1] - [Happy Hacking Keyboard professional][GH_hhkb] 29* hhkb - [Happy Hacking Keyboard professional][GH_hhkb]
29* [macway][k2] - [Compact keyboard mod][GH_macway] 30* macway - [Compact keyboard mod][GH_macway]
30* [hbkb][k3] - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb] 31* hbkb - [Happy Buckling sprint keyboard(IBM Model M mod)][GH_hbkb]
31 32
32[c1]: converter/ps2_usb/
33[c2]: converter/adb_usb/
34[c3]: converter/m0110_usb/
35[c4]: converter/terminal_usb/
36[c5]: converter/news_usb/
37[c6]: converter/x68k_usb/
38[k1]: keyboard/hhkb
39[k2]: keyboard/macway
40[k3]: keyboard/hbkb
41[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930 33[GH_macway]: http://geekhack.org/showwiki.php?title=Island:11930
42[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047 34[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
43[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618 35[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
@@ -54,21 +46,24 @@ Projects
54Files & Directories 46Files & Directories
55------------------- 47-------------------
56### Top 48### Top
57* [common/](common/) - common codes 49* common/ - common codes
58* [protocol/](protocol/) - keyboard protocol support 50* protocol/ - keyboard protocol support
59* [keyboard/](keyboard/) - keyboard projects 51* keyboard/ - keyboard projects
60* [converter/](converter/) - protocol converter projects 52* converter/ - protocol converter projects
61* [doc/](doc/) - documents 53* doc/ - documents
54* common.mk - Makefile for common
55* protoco.mk - Makefile for protocol
56* rules.mk - Makefile for build rules
62 57
63### Keyboard Protocols 58### Keyboard Protocols
64* [pjrc/](protocol/pjrc/) - PJRC USB stack 59* pjrc/ - PJRC USB stack
65* [vusb/](protocol/vusb/) - Objective Development V-USB 60* vusb/ - Objective Development V-USB
66* [iwrap/](protocol/iwrap) - Bluetooth HID for Bluegiga iWRAP 61* iwrap/ - Bluetooth HID for Bluegiga iWRAP
67* [ps2.c](protocol/ps2.c) - PS/2 protocol 62* ps2.c - PS/2 protocol
68* [adb.c](protocol/adb.c) - Apple Desktop Bus protocol 63* adb.c - Apple Desktop Bus protocol
69* [m0110.c](protocol/m0110.c) - Macintosh 128K/512K/Plus keyboard protocol 64* m0110.c - Macintosh 128K/512K/Plus keyboard protocol
70* [news.c](protocol/news.c) - Sony NEWS keyboard protocol 65* news.c - Sony NEWS keyboard protocol
71* [x68k.c](protocol/x68k.c) - Sharp X68000 keyboard protocol 66* x68k.c - Sharp X68000 keyboard protocol
72 67
73 68
74Build & Program 69Build & Program
@@ -86,7 +81,7 @@ The firmware will be compiled as a file `tmk_<project>.hex`.
86[crosspack]: http://www.obdev.at/products/crosspack/index.html 81[crosspack]: http://www.obdev.at/products/crosspack/index.html
87 82
88### Program Controller 83### Program Controller
89If you have proper program command in Makefile just type this. 84If you have a proper program command in `Makefile` just type this.
90 85
91 $ make program 86 $ make program
92 87
@@ -94,23 +89,25 @@ As for `Teensy` you can use `PJRC's loader` to program hex file. <http://www.pjr
94 89
95 90
96 91
97Build Options 92Makefile Options
98------------- 93----------------
99### `Makefile` 94### 1. MCU and Frequency.
100#### 1. MCU and Frequency. 95
101 MCU = atmega32u4 # Teensy 2.0 96 MCU = atmega32u4 # Teensy 2.0
102 #MCU = at90usb1286 # Teensy++ 2.0 97 #MCU = at90usb1286 # Teensy++ 2.0
103 F_CPU = 16000000 98 F_CPU = 16000000
104 99
105#### 2. Features 100### 2. Features
106Note that ***comment out*** to disable them. 101Note that ***comment out*** to disable them.
102
107 MOUSEKEY_ENABLE = yes # Mouse keys 103 MOUSEKEY_ENABLE = yes # Mouse keys
108 PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support 104 PS2_MOUSE_ENABLE = yes # PS/2 mouse(TrackPoint) support
109 EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control) 105 EXTRAKEY_ENABLE = yes # Enhanced feature for Windows(Audio control and System control)
110 NKRO_ENABLE = yes # USB Nkey Rollover 106 NKRO_ENABLE = yes # USB Nkey Rollover
111 107
112#### 3. Programmer 108### 3. Programmer
113Set proper command for your controller, bootloader and programmer. 109Set proper command for your controller, bootloader and programmer.
110
114 # for PJRC Teensy 111 # for PJRC Teensy
115 PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex 112 PROGRAM_CMD = teensy_loader_cli -mmcu=$(MCU) -w -v $(TARGET).hex
116 113
@@ -122,8 +119,9 @@ Set proper command for your controller, bootloader and programmer.
122 PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex 119 PROGRAM_CMD = avrdude -p $(MCU) -c usbasp -U flash:w:$(TARGET).hex
123 PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex 120 PROGRAM_CMD = avrdude -p $(MCU) -c arduino -P COM1 -b 57600 -U flash:w:$(TARGET).hex
124 121
125### `config.h` 122config.h Options
126#### 1. USB vendor/product ID and device description 123----------------
124### 1. USB vendor/product ID and device description
127 #define VENDOR_ID 0xFEED 125 #define VENDOR_ID 0xFEED
128 #define PRODUCT_ID 0xBEEF 126 #define PRODUCT_ID 0xBEEF
129 /* device description */ 127 /* device description */
@@ -131,14 +129,18 @@ Set proper command for your controller, bootloader and programmer.
131 #define PRODUCT Macway mod 129 #define PRODUCT Macway mod
132 #define DESCRIPTION t.m.k. keyboard firmware for Macway mod 130 #define DESCRIPTION t.m.k. keyboard firmware for Macway mod
133 131
134#### 2. Keyboard matrix configuration 132### 2. Keyboard matrix configuration
135 #define MATRIX_ROWS 8 133 #define MATRIX_ROWS 8
136 #define MATRIX_COLS 8 134 #define MATRIX_COLS 8
137 #define MATRIX_HAS_GHOST 135 #define MATRIX_HAS_GHOST
138 136
139### 3. Mouse keys configuration 137### 3. Mouse keys
138
139### 4. PS/2 mouse
140
141### 5. COMMAND key combination
140 142
141### 4. PS/2 mouse configuration 143 #define IS_COMMAND() (keyboard_report->mods == (MOD_BIT(KB_LSHIFT) | MOD_BIT(KB_RSHIFT)))
142 144
143 145
144Keymap 146Keymap