-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 74944ae
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Quantum Mechanical Keyboard Firmware | ||
|
||
[](https://github.com/qmk/qmk_firmware/tags) | ||
[](https://travis-ci.org/qmk/qmk_firmware) | ||
[](https://gitter.im/qmk/qmk_firmware) | ||
[](https://docs.qmk.fm) | ||
[](https://github.com/qmk/qmk_firmware/pulse/monthly) | ||
[](https://github.com/qmk/qmk_firmware/) | ||
|
||
This is a keyboard firmware based on the [tmk\_keyboard firmware](http://github.com/tmk/tmk_keyboard) with some useful features for Atmel AVR and ARM 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/). | ||
|
||
## Official website | ||
|
||
[http://qmk.fm](http://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK. | ||
|
||
## Supported Keyboards | ||
|
||
* [Planck](/keyboards/planck/) | ||
* [Preonic](/keyboards/preonic/) | ||
* [ErgoDox EZ](/keyboards/ergodox_ez/) | ||
* [Clueboard](/keyboards/clueboard_66/) | ||
* [Cluepad](/keyboards/clueboard_17/) | ||
|
||
The project also includes community support for [lots of other keyboards](/keyboards/). | ||
|
||
## Maintainers | ||
|
||
QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, [Hasu](https://github.com/tmk). 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). | ||
|
||
## Documentation | ||
|
||
[https://docs.qmk.fm](https://docs.qmk.fm) is hosted on [Gitbook](https://www.gitbook.com/book/qmk/firmware/details) and [GitHub](/docs/) (they are synced). You can request changes by making a fork and [pull request](https://github.com/qmk/qmk_firmware/pulls), or by clicking the "suggest an edit" link on any page of the Docs. |