Go to file

QMK Bot 397e8e461f Merge remote-tracking branch 'origin/master' into develop		2021-01-22 17:11:22 +00:00
.github	…
.vscode	…
api_data	…
bin	…
data/schemas	…
docs	Merge remote-tracking branch 'origin/master' into develop	2021-01-20 18:46:42 +00:00
drivers	…
keyboards	Merge remote-tracking branch 'origin/master' into develop	2021-01-22 17:11:22 +00:00
layouts	Merge remote-tracking branch 'origin/master' into develop	2021-01-22 16:23:41 +00:00
lib	ChibiOS conf migrations... take 11 (#11646 )	2021-01-21 17:00:53 +11:00
platforms/chibios	ChibiOS enable memory allocations (#11620 )	2021-01-19 14:50:51 +00:00
quantum	Keep track of encoder activity (#11595 )	2021-01-21 22:24:07 +11:00
tests	…
tmk_core	Keep track of encoder activity (#11595 )	2021-01-21 22:24:07 +11:00
users	[Keymap] Cleanup and updating of drashna keymap code (#11516 )	2021-01-22 08:23:03 -08:00
util	Merge remote-tracking branch 'origin/master' into develop	2021-01-13 16:13:04 +00:00
.clang-format	…
.editorconfig	…
.gitattributes	…
.gitignore	Generate api data on each push (#10609 )	2020-10-25 14:48:44 -07:00
.gitmodules	…
.travis.yml	…
CODE_OF_CONDUCT.md	…
Dockerfile	…
Doxyfile	…
LICENSE	…
Makefile	…
Vagrantfile	…
book.json	…
bootloader.mk	Add stm32-dfu and apm32-dfu to bootloader.mk (#11019 )	2021-01-20 14:04:21 +11:00
build_full_test.mk	…
build_json.mk	…
build_keyboard.mk	move the info.json rules above userspace	2021-01-13 16:01:21 -08:00
build_layout.mk	…
build_test.mk	…
common.mk	…
common_features.mk	…
doxygen-todo	…
license_GPLv2.md	…
license_GPLv3.md	Clarify the quantum license (#1042 )	2017-03-28 15:20:36 -07:00
license_Modified_BSD.md	…
message.mk	…
nose2.cfg	…
readme.md	…
requirements-dev.txt	…
requirements.txt	…
secrets.tar.enc	update building for .hex, secrets moving	2017-08-21 21:57:46 -04:00
setup.cfg	…
shell.nix	…
show_options.mk	…
testlist.mk	…

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.