Go to file
QMK Bot 6f9db2b48e Merge remote-tracking branch 'origin/master' into develop 2021-01-11 08:07:48 +00:00
.github
.vscode
api_data
bin
data/schemas Add support for specifying BOARD in info.json (#11492) 2021-01-09 20:18:47 -08:00
docs Merge remote-tracking branch 'origin/master' into develop 2021-01-11 07:05:39 +00:00
drivers
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-01-11 08:05:02 +00:00
layouts [Keymap] stanrc85 Keymap/userspace updates (#11349) 2021-01-10 23:03:12 -08:00
lib Add support for specifying BOARD in info.json (#11492) 2021-01-09 20:18:47 -08:00
platforms/chibios Disable subsystems repo-wide. (#11449) 2021-01-10 09:52:49 +11:00
quantum Merge remote-tracking branch 'origin/master' into develop 2021-01-11 08:07:48 +00:00
tests
tmk_core Merge remote-tracking branch 'origin/master' into develop 2021-01-11 08:07:48 +00:00
users [Keymap] stanrc85 Keymap/userspace updates (#11349) 2021-01-10 23:03:12 -08:00
util remove the python dep update 2021-01-07 21:21:12 -08:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
book.json
bootloader.mk
build_full_test.mk
build_json.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
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt validate keyboard data with jsonschema 2021-01-07 21:21:12 -08:00
secrets.tar.enc
setup.cfg Use the schema to eliminate custom code (#11108) 2021-01-09 13:34:14 -08:00
shell.nix
show_options.mk
testlist.mk

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Discord Docs Status GitHub contributors GitHub forks

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

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.