Go to file

QMK Bot d5c89c8ed5 Merge remote-tracking branch 'origin/master' into develop		2020-12-30 14:02:54 +00:00
.github	…
.vscode	…
api_data	…
bin	…
docs	Merge remote-tracking branch 'origin/master' into develop	2020-12-30 14:02:54 +00:00
drivers	Rewrite APA102 support (#10894 )	2020-12-30 00:28:49 +00:00
keyboards	Merge remote-tracking branch 'origin/master' into develop	2020-12-30 09:06:36 +00:00
layouts	…
lib	[CLI] Add stdin support for json2c command (#11289 )	2020-12-29 11:34:48 -08:00
platforms/chibios	Merge remote-tracking branch 'origin/master' into develop	2020-12-27 17:37:04 +00:00
quantum	Merge remote-tracking branch 'origin/master' into develop	2020-12-30 03:41:33 +00:00
tests	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
tmk_core	Merge remote-tracking branch 'origin/master' into develop	2020-12-30 09:59:32 +00:00
users	…
util	Merge remote-tracking branch 'origin/master' into develop	2020-12-30 04:12:32 +00:00
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	…
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	remove some old and unused code from Makefile (#11336 )	2020-12-29 19:42:09 +00:00
Vagrantfile	…
book.json	…
bootloader.mk	…
build_full_test.mk	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
build_json.mk	…
build_keyboard.mk	…
build_layout.mk	…
build_test.mk	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
common.mk	…
common_features.mk	Rewrite APA102 support (#10894 )	2020-12-30 00:28:49 +00:00
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	…
license_Modified_BSD.md	…
message.mk	…
nose2.cfg	…
readme.md	…
requirements-dev.txt	…
requirements.txt	…
secrets.tar.enc	…
setup.cfg	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00
shell.nix	…
show_options.mk	…
testlist.mk	Ensure single newline at EOF for core files (#11310 )	2020-12-28 04:36:32 +11:00

readme.md

Quantum Mechanical Keyboard Firmware

THIS IS THE DEVELOP BRANCH

Warning- This is the develop branch of QMK Firmware. You may encounter broken code here. Please see Breaking Changes for more information.

Original readme 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

See the official documentation on docs.qmk.fm

The docs are powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

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.