diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2015-10-27 11:54:46 -0400 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2015-10-27 11:54:46 -0400 |
| commit | a766918d5c48204375f4c207b30bbbf1389df14f (patch) | |
| tree | 24aa069aacdaff4044ba3a63f66f7db5c6851405 /README.md | |
| parent | 53f7c6535d9c5c55ae9765030327d6819e251592 (diff) | |
| download | qmk_firmware-a766918d5c48204375f4c207b30bbbf1389df14f.tar.gz qmk_firmware-a766918d5c48204375f4c207b30bbbf1389df14f.zip | |
README changes
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 24 |
1 files changed, 18 insertions, 6 deletions
| @@ -1,6 +1,6 @@ | |||
| 1 | Quantum MK Firmware | 1 | Quantum MK Firmware |
| 2 | ================================ | 2 | ================================ |
| 3 | This is a keyboard firmware with some useful features for Atmel AVR controller, based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard). | 3 | 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. |
| 4 | 4 | ||
| 5 | Features | 5 | Features |
| 6 | -------- | 6 | -------- |
| @@ -27,6 +27,18 @@ Projects | |||
| 27 | -------- | 27 | -------- |
| 28 | You can find some keyboard specific projects under `converter` and `keyboard` directory. | 28 | You can find some keyboard specific projects under `converter` and `keyboard` directory. |
| 29 | 29 | ||
| 30 | ## Main projects | ||
| 31 | |||
| 32 | ### OLKB products | ||
| 33 | * [planck](keyboard/planck/) - [Planck] Ortholinear 40% keyboard | ||
| 34 | * [preonic](keyboard/preonic/) - [Preonic] Ortholinear 50% keyboard | ||
| 35 | * [atomic](keyboard/atomic/) - [Atomic] Ortholinear 60% keyboard | ||
| 36 | |||
| 37 | ### Ergodox EZ | ||
| 38 | * [ergodox_ez](keyboard/ergodox_ez) - [Ergodox_EZ] Assembled split keyboard | ||
| 39 | |||
| 40 | ## Other projects | ||
| 41 | |||
| 30 | ### converter | 42 | ### converter |
| 31 | * [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2] | 43 | * [ps2_usb](converter/ps2_usb/) - [PS/2 keyboard to USB][GH_ps2] |
| 32 | * [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb] | 44 | * [adb_usb](converter/adb_usb/) - [ADB keyboard to USB][GH_adb] |
| @@ -55,8 +67,6 @@ You can find some keyboard specific projects under `converter` and `keyboard` di | |||
| 55 | * [KittenPaw](keyboard/kitten_paw) - Custom Majestouch controller | 67 | * [KittenPaw](keyboard/kitten_paw) - Custom Majestouch controller |
| 56 | * [Lightpad](keyboard/lightpad) - Korean custom keypad | 68 | * [Lightpad](keyboard/lightpad) - Korean custom keypad |
| 57 | * [ghost_squid](keyboard/ghost_squid/) - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt] | 69 | * [ghost_squid](keyboard/ghost_squid/) - [The Ghost Squid][ghost_squid] controller for [Cooler Master QuickFire XT][cmxt] |
| 58 | * [planck](keyboard/planck/) - [Planck] Ortholinear 40% keyboard | ||
| 59 | * [atomic](keyboard/atomic/) - [Atomic] Ortholinear 60% keyboard | ||
| 60 | 70 | ||
| 61 | ### Extenal projects using tmk_keyboard | 71 | ### Extenal projects using tmk_keyboard |
| 62 | * [ErgoDox_cub-uanic][cub-uanic] - Split Ergonomic Keyboard [ErgoDox][ergodox_org] | 72 | * [ErgoDox_cub-uanic][cub-uanic] - Split Ergonomic Keyboard [ErgoDox][ergodox_org] |
| @@ -88,8 +98,10 @@ You can find some keyboard specific projects under `converter` and `keyboard` di | |||
| 88 | [cub-uanic]: https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox | 98 | [cub-uanic]: https://github.com/cub-uanic/tmk_keyboard/tree/master/keyboard/ergodox |
| 89 | [mcdox]: https://github.com/DavidMcEwan/mcdox | 99 | [mcdox]: https://github.com/DavidMcEwan/mcdox |
| 90 | [mcdox_tmk]: https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox | 100 | [mcdox_tmk]: https://github.com/DavidMcEwan/tmk_keyboard/tree/master/keyboard/mcdox |
| 91 | [Planck]: http://planckkeyboard.com | 101 | [Planck]: http://olkb.co/planck |
| 92 | [Atomic]: http://atomickeyboard.com | 102 | [Preonic]: http://olkb.co/preonic |
| 103 | [Atomic]: http://olkb.co/atomic | ||
| 104 | [Ergodox_EZ]: https://www.indiegogo.com/projects/ergodox-ez-an-incredible-mechanical-keyboard | ||
| 93 | 105 | ||
| 94 | 106 | ||
| 95 | License | 107 | License |
| @@ -101,7 +113,7 @@ LUFA, PJRC and V-USB stack have their own license respectively. | |||
| 101 | 113 | ||
| 102 | Build Firmware and Program Controller | 114 | Build Firmware and Program Controller |
| 103 | ------------------------------------- | 115 | ------------------------------------- |
| 104 | See [doc/build.md](doc/build.md). | 116 | See [doc/build.md](doc/build.md), or the README in the particular keyboard/* folder. |
| 105 | 117 | ||
| 106 | 118 | ||
| 107 | 119 | ||
