Update orphan/README.md
[tmk_keyboard.git] / README.md
CommitLineData
78fd5a71 1TMK Keyboard Firmware Collection
2================================
885e7adb 3This repository includes keyboard and converter firmware projects built with [`tmk_core`][tmk_core] keyboard library.
afb08462 4
885e7adb 5The latest source code is available here: <http://github.com/tmk/tmk_keyboard>
afb08462 6
7
799993c4
JW
8Updates
9-------
885e7adb 10#### 2016/06/22
11Some projects were moved from `converter` and `keyboard` to `orphan` directory. Those might be removed in some future but you will be able to access them with `orphans` tag. See <https://github.com/tmk/tmk_keyboard/issues/173>
12
5b8e4ca2 13#### 2016/02/10
14core: flabbergast's Chibios protocol was merged from <https://github.com/flabbergast/tmk_keyboard/tree/chibios> (@72b1668). See [tmk_core/protocol/chibios/README.md](tmk_core/protocol/chibios/README.md). Chibios protocol supports Cortex-M such as STM32 and Kinetis.
15
799993c4
JW
16#### 2015/04/22
17Core library was separated to other branch `core`. <https://github.com/tmk/tmk_keyboard/tree/core>
18
19In `Makefile` you need to set `TMK_DIR` to indicate core library location now.
20
21 TMK_DIR = ../../tmk_core
22
23
24
afb08462 25Projects
26--------
083c7581 27You can find some keyboard specific projects under `converter` and `keyboard` directory.
28
afb08462 29### converter
1aa067e5 30* [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2]
31* [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb]
22bd315b 32* [m0110_usb](converter/m0110_usb) - [Macintosh 128K/512K/Plus keyboard to USB][GH_m0110]
1aa067e5 33* [terminal_usb](converter/terminal_usb/) - [IBM Model M terminal keyboard(PS/2 scancode set3) to USB][GH_terminal]
34* [news_usb](converter/news_usb/) - [Sony NEWS keyboard to USB][GH_news]
35* [x68k_usb](converter/x68k_usb/) - [Sharp X68000 keyboard to USB][GH_x68k]
633d9aa5 36* [sun_usb](converter/sun_usb/) - [Sun] to USB(type4, 5 and 3?)
37* [pc98_usb](converter/pc98_usb/) - [PC98] to USB
885e7adb 38* [usb_usb](converter/usb_usb/) - [USB to USB][GH_usb]
39* [ibm4704_usb](converter/ibm4704_usb) - [IBM 4704 keyboard to USB][GH_ibm4704]
40* [next_usb](converter/next_usb) - NeXT(Non-ADB) to USB, contributed by [BCG](https://github.com/bgould) and based on [Adafruit's work](https://learn.adafruit.com/usb-next-keyboard-with-arduino-micro/overview)
afb08462 41
42### keyboard
78fd5a71 43* [hhkb](keyboard/hhkb/) - [Happy Hacking Keyboard pro][GH_hhkb] **my main board**
885e7adb 44* [alps64](keyboard/alps64/) - [Alps64 PCB](https://geekhack.org/index.php?topic=69740.0)
78fd5a71 45* [hbkb](keyboard/hbkb/) - [Happy Buckling spring keyboard][GH_hbkb](IBM Model M 60% mod)
d0fefb76 46* [Infinity](keyboard/infinity/) - Massdrop [Infinity keyboard][Infinity]
885e7adb 47* [gh60](keyboard/gh60/) - [GH60] DIY 60% keyboard [prototype][GH60_proto] **my second board**
48* [onekey](keyboard/onekey/) - Simple one key keyboard example
784c6e39 49
885e7adb 50
51### Projects based tmk_keyboard or tmk_core
52https://github.com/tmk/tmk_keyboard/wiki/TMK-Based-Projects
771347c4 53
54
afb08462 55[GH_hhkb]: http://geekhack.org/showwiki.php?title=Island:12047
56[GH_ps2]: http://geekhack.org/showwiki.php?title=Island:14618
57[GH_adb]: http://geekhack.org/showwiki.php?title=Island:14290
58[GH_hhkb_bt]: http://geekhack.org/showwiki.php?title=Island:20851
59[GH_m0110]: http://geekhack.org/showwiki.php?title=Island:24965
81706d11 60[GH_news]: http://geekhack.org/showwiki.php?title=Island:25759
afb08462 61[GH_terminal]: http://geekhack.org/showwiki.php?title=Island:27272
62[GH_x68k]: http://geekhack.org/showwiki.php?title=Island:29060
81706d11 63[GH_hbkb]: http://geekhack.org/showwiki.php?title=Island:29483
428b2364 64[GH_ibm4704]: http://geekhack.org/index.php?topic=54706.0
74ecdd15 65[GH60]: http://geekhack.org/index.php?topic=34959
78fd5a71 66[GH60_proto]: http://geekhack.org/index.php?topic=37570.0
633d9aa5 67[PC98]: http://en.wikipedia.org/wiki/NEC_PC-9801
68[Sun]: http://en.wikipedia.org/wiki/Sun-3
d0fefb76 69[Infinity]: https://www.massdrop.com/buy/infinity-keyboard-kit
afb08462 70
71
72
78fd5a71 73License
74-------
75**GPLv2** or later. Some protocol files are under **Modified BSD License**.
1d5bac21
JW
76
77Third party libraries like LUFA, PJRC and V-USB have their own license respectively.
74ecdd15 78
afb08462 79
784c6e39 80
78fd5a71 81Build Firmware and Program Controller
82-------------------------------------
24c30681 83See [tmk_core/doc/build.md](tmk_core/doc/build.md).
afb08462 84
afb08462 85
86
083c7581 87Change your keymap
88------------------
24c30681 89See [tmk_core/doc/keymap.md](tmk_core/doc/keymap.md).
afb08462 90
91
74ecdd15 92
22bd315b 93Magic Commands
74ecdd15 94--------------
95To see help press `Magic` + `H`.
96
885e7adb 97`Magic` key combination is `LShift` + `RShift` in many projects, but `Power` key on ADB converter.
1d5bac21 98`Magic` keybind can be vary on each project, check `config.h` in project directory.
74ecdd15 99
100Following commands can be also executed with `Magic` + key. In console mode `Magic` keybind is not needed.
101
102 ----- Command Help -----
103 c: enter console mode
104 d: toggle debug enable
105 x: toggle matrix debug
106 k: toggle keyboard debug
107 m: toggle mouse debug
74ecdd15 108 v: print device version & info
109 t: print timer count
110 s: print status
4e93b3fa 111 e: print eeprom config
112 n: toggle NKRO
74ecdd15 113 0/F10: switch to Layer0
114 1/F1: switch to Layer1
115 2/F2: switch to Layer2
116 3/F3: switch to Layer3
117 4/F4: switch to Layer4
118 PScr: power down/remote wake-up
119 Caps: Lock Keyboard(Child Proof)
120 Paus: jump to bootloader
121
39d09333 122
799993c4
JW
123
124Boot Magic Configuration - Virtual DIP Switch
125---------------------------------------------
22bd315b 126Boot Magic are executed during boot up time. Press Magic key below then plug in keyboard cable.
4e93b3fa 127Note that you must use keys of **Layer 0** as Magic keys. These settings are stored in EEPROM so that retain your configure over power cycles.
39d09333 128
799993c4 129To avoid configuring accidentally additive salt key `KC_SPACE` also needs to be pressed along with the following configuration keys. The salt key is configurable in `config.h`. See [tmk_core/common/bootmagic.h](tmk_core/common/bootmagic.h).
05225dd9 130
dad9dab9 131#### General
132- Skip reading EEPROM to start with default configuration(`ESC`)
133- Clear configuration stored in EEPROM to reset configuration(`Backspace`)
4e93b3fa 134
135#### Bootloader
8b9bd51d 136- Kick up Bootloader(`B`)
4e93b3fa 137
138#### Debug
8b9bd51d 139- Debug enable(`D`)
4e93b3fa 140- Debug matrix enable(`D`+`X`)
141- Debug keyboard enable(`D`+`K`)
142- Debug mouse enable(`D`+`M`)
143
144#### Keymap
8b9bd51d 145- Swap Control and CapsLock(`Left Control`)
22bd315b 146- Change CapsLock to Control(`Caps Lock`)
8b9bd51d 147- Swap LeftAlt and Gui(`Left Alt`)
148- Swap RightAlt and Gui(`Right Alt`)
149- Disable Gui(`Left Gui`)
150- Swap Grave and Escape(`Grave`)
151- Swap BackSlash and BackSpace(`Back Slash`)
e5bafff7 152- Enable NKRO on boot(`N`)
39d09333 153
4e93b3fa 154#### Default Layer
155- Set Default Layer to 0(`0`)
dad9dab9 156- Set Default Layer to 1(`1`)
157- Set Default Layer to 2(`2`)
158- Set Default Layer to 3(`3`)
9de9d719 159- Set Default Layer to 4(`4`)
160- Set Default Layer to 5(`5`)
161- Set Default Layer to 6(`6`)
162- Set Default Layer to 7(`7`)
163
39d09333 164
74ecdd15 165
27210220 166Mechanical Locking support
167--------------------------
885e7adb 168This feature makes it possible for you to use mechanical locking switch for `CapsLock`, `NumLock`
1d5bac21
JW
169or `ScrollLock`. To enable this feature define these macros in `config.h` and use `KC_LCAP`, `KC_LN
170UM` or `KC_LSCR` in keymap for locking key instead of normal `KC_CAPS`, `KC_NLCK` or `KC_SLCK`. Res
171ync option tries to keep switch state consistent with keyboard LED state.
885e7adb 172
27210220 173 #define LOCKING_SUPPORT_ENABLE
174 #define LOCKING_RESYNC_ENABLE
c0137b4b 175
74ecdd15 176
799993c4 177
74ecdd15 178Start Your Own Project
afb08462 179-----------------------
885e7adb 1801. Add `tmk_core` into your repository using `git submodule` or `git subtree`.
1812. Copy files from `tmk_keybaord` or other project similar to yours
1823. Edit those files to support your keyboard.
183
184See these as examples.
185- https://github.com/tmk/infinity_ergodox
186- https://github.com/tmk/whitefox
78fd5a71 187
188
189
22bd315b 190Debugging
78fd5a71 191--------
885e7adb 192Use PJRC's `hid_listen` to see debug messages. You can use xprintf() to display debug info, see `tmk_core/common/xprintf.h`.
afb08462 193
885e7adb 194- https://www.pjrc.com/teensy/hid_listen.html
78fd5a71 195
196
197
198Files and Directories
74ecdd15 199-------------------
200### Top
74ecdd15 201* keyboard/ - keyboard projects
202* converter/ - protocol converter projects
24c30681 203* tmk_core/ - core library
204* tmk_core/doc/ - documents
afb08462 205
afb08462 206
afb08462 207
885e7adb 208Contribution
209------------
210- Report bugs in github **[Issues](https://github.com/tmk/tmk_keyboard/issues)**.
211- Pull requets are also welcomed.
212
213
214
22bd315b 215Coding Style
de7b46cd 216-------------
217- Doesn't use Tab to indent, use 4-spaces instead.
218
219
220
78fd5a71 221Other Keyboard Firmware Projects
222------------------
d4982a21 223You can learn a lot about keyboard firmware from these. See [Other Projects](https://github.com/tmk/tmk_keyboard/wiki/Other-Projects) other than TMK.
Imprint / Impressum