diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 19 insertions, 7 deletions
@@ -1,9 +1,6 @@ -TMK Keyboard Firmware Collection +Quantum MK Firmware ================================ -This is a keyboard firmware with some useful features for Atmel AVR controller. - -Source code is available here: <http://github.com/tmk/tmk_keyboard> - +This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controller, and more specifically, the OLKB product line. Updates ------- @@ -42,6 +39,18 @@ Projects -------- You can find some keyboard specific projects under `converter` and `keyboard` directory. +## Main projects + +### OLKB products +* [planck](keyboard/planck/) - [Planck] Ortholinear 40% keyboard +* [preonic](keyboard/preonic/) - [Preonic] Ortholinear 50% keyboard +* [atomic](keyboard/atomic/) - [Atomic] Ortholinear 60% keyboard + +### Ergodox EZ +* [ergodox_ez](keyboard/ergodox_ez) - [Ergodox_EZ] Assembled split keyboard + +## Other projects + ### converter * [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2] * [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb] @@ -101,7 +110,10 @@ You can find some keyboard specific projects under `converter` and `keyboard` di [cub-uanic]: https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox [mcdox]: https://github.com/DavidMcEwan/mcdox [mcdox_tmk]: https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox - +[Planck]: http://olkb.co/planck +[Preonic]: http://olkb.co/preonic +[Atomic]: http://olkb.co/atomic +[Ergodox_EZ]: https://www.indiegogo.com/projects/ergodox-ez-an-incredible-mechanical-keyboard License @@ -114,7 +126,7 @@ Third party libraries like LUFA, PJRC and V-USB have their own license respectiv Build Firmware and Program Controller ------------------------------------- -See [doc/build.md](doc/build.md). +See [doc/build.md](doc/build.md), or the README in the particular keyboard/* folder. |