Go to file

Fredric Silberberg e9755521ab Update README with rules.mk ordering information.		2018-07-17 00:10:42 -04:00
.vscode	…
docs	Update README with rules.mk ordering information.	2018-07-17 00:10:42 -04:00
drivers	…
keyboards	…
layouts	…
lib	…
quantum	…
tests	…
tmk_core	…
users	…
util	…
.clang_complete	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	…
Vagrantfile	…
autocomplete.sh	…
book.json	…
bootloader.mk	…
build_full_test.mk	…
build_keyboard.mk	…
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	…
readme.md	…
secrets.tar.enc	…
shell.nix	…
testlist.mk	…

readme.md

Quantum Mechanical Keyboard Firmware

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

See the official documentation on docs.qmk.fm

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 Erez Zukerman, and the Clueboard by Zach White.

Official website

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.