diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 6 |
1 files changed, 3 insertions, 3 deletions
| @@ -1,6 +1,6 @@ | |||
| 1 | # Quantum Mechanical Keyboard Firmware | 1 | # Quantum Mechanical Keyboard Firmware |
| 2 | 2 | ||
| 3 | [](https://travis-ci.org/jackhumbert/qmk_firmware) | 3 | [](https://travis-ci.org/jackhumbert/qmk_firmware) [](https://gitter.im/qmk/qmk_firmware?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
| 4 | 4 | ||
| 5 | This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). | 5 | This is a keyboard firmware based on the [tmk_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co/). |
| 6 | 6 | ||
| @@ -23,7 +23,7 @@ The project also includes community support for [lots of other keyboards](/keybo | |||
| 23 | 23 | ||
| 24 | QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). This repo used to be a fork of [TMK](https://github.com/tmk/tmk_keyboard), and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons - it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK and Hasu :) | 24 | QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). This repo used to be a fork of [TMK](https://github.com/tmk/tmk_keyboard), and we are incredibly grateful for his founding contributions to the firmware. We've had to break the fork due to purely technical reasons - it simply became too different over time, and we've had to start refactoring some of the basic bits and pieces. We are huge fans of TMK and Hasu :) |
| 25 | 25 | ||
| 26 | This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please [open an issue](https://github.com/jackhumbert/qmk_firmware/issues/new). | 26 | This documentation is edited and maintained by Erez Zukerman of ErgoDox EZ. If you spot any typos or inaccuracies, please [open an issue](https://github.com/qmk/qmk_firmware/issues/new). |
| 27 | 27 | ||
| 28 | The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [Erez Zukerman](https://github.com/ezuk), and the Clueboard by [Zach White](https://github.com/skullydazed). | 28 | The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/jackhumbert), the Ergodox EZ by [Erez Zukerman](https://github.com/ezuk), and the Clueboard by [Zach White](https://github.com/skullydazed). |
| 29 | 29 | ||
| @@ -31,7 +31,7 @@ The OLKB product firmwares are maintained by [Jack Humbert](https://github.com/j | |||
| 31 | 31 | ||
| 32 | This is not a tiny project. While this is the main readme, there are many other files you might want to consult. Here are some points of interest: | 32 | This is not a tiny project. While this is the main readme, there are many other files you might want to consult. Here are some points of interest: |
| 33 | 33 | ||
| 34 | * [**The Wiki**](https://github.com/jackhumbert/qmk_firmware/wiki) - the entirety of the readme has been moved here | 34 | * [**The Wiki**](https://github.com/qmk/qmk_firmware/wiki) - the entirety of the readme has been moved here |
| 35 | * The readme for your own keyboard: This is found under `keyboards/<your keyboards's name>/`. So for the ErgoDox EZ, it's [here](keyboards/ergodox/ez/); for the Planck, it's [here](keyboards/planck/) and so on. | 35 | * The readme for your own keyboard: This is found under `keyboards/<your keyboards's name>/`. So for the ErgoDox EZ, it's [here](keyboards/ergodox/ez/); for the Planck, it's [here](keyboards/planck/) and so on. |
| 36 | * The list of possible keycodes you can use in your keymap is actually spread out in a few different places: | 36 | * The list of possible keycodes you can use in your keymap is actually spread out in a few different places: |
| 37 | * [doc/keycode.txt](doc/keycode.txt) - an explanation of those same keycodes. | 37 | * [doc/keycode.txt](doc/keycode.txt) - an explanation of those same keycodes. |
