|
|
||
|---|---|---|
| .github | ||
| .vscode | ||
| bin | ||
| docs | ||
| drivers | ||
| keyboards | ||
| layouts | ||
| lib | ||
| quantum | ||
| tests | ||
| tmk_core | ||
| users | ||
| util | ||
| .clang_complete | ||
| .clang-format | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .travis.yml | ||
| autocomplete.sh | ||
| book.json | ||
| bootloader.mk | ||
| build_full_test.mk | ||
| build_json.mk | ||
| build_keyboard.mk | ||
| build_layout.mk | ||
| build_test.mk | ||
| CODE_OF_CONDUCT.md | ||
| common_features.mk | ||
| common.mk | ||
| Dockerfile | ||
| Doxyfile | ||
| doxygen-todo | ||
| LICENSE | ||
| license_GPLv2.md | ||
| license_GPLv3.md | ||
| license_Modified_BSD.md | ||
| Makefile | ||
| message.mk | ||
| readme.md | ||
| requirements.txt | ||
| secrets.tar.enc | ||
| setup.cfg | ||
| shell.nix | ||
| show_options.mk | ||
| testlist.mk | ||
| Vagrantfile | ||
Quantum Mechanical Keyboard Firmware
NOTICE: THIS IS A TESTING BRANCH
This is the breaking_changes branch for Aug 2019. You can read more in the tracking issue.
We encourage you to try this branch out and see if there are any bugs. Our goal is to merge this branch to master on Aug 30. Please report any bugs you find.
Original readme.md continues:
This is a keyboard firmware based on the tmk_keyboard firmware with some useful features for Atmel AVR and ARM controllers, and more specifically, the OLKB product line, the ErgoDox EZ keyboard, and the Clueboard product line.
Documentation
The docs are hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.
Supported Keyboards
The project also includes community support for lots of other keyboards.
Maintainers
QMK is developed and maintained by Jack Humbert of OLKB with contributions from the community, and of course, Hasu. The OLKB product firmwares are maintained by Jack Humbert, the Ergodox EZ by ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.
Official Website
qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.