Go to file
QMK Bot 4e32465f06 Merge remote-tracking branch 'origin/master' into develop 2021-05-16 00:08:53 +00:00
.github Merge remote-tracking branch 'origin/master' into develop 2021-05-10 18:19:15 +00:00
.vscode
api_data
bin Merge remote-tracking branch 'origin/master' into develop 2021-05-10 12:16:04 -07:00
data
docs Deprecate `send_unicode_hex_string()` (#12602) 2021-05-14 03:25:40 +10:00
drivers Merge remote-tracking branch 'origin/master' into develop 2021-05-09 17:15:32 +00:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-05-16 00:08:53 +00:00
layouts Merge remote-tracking branch 'origin/master' into develop 2021-05-13 00:18:40 +00:00
lib Add setup, clone, and env to the list of commands we allow even with broken modules (#12868) 2021-05-12 09:40:58 -07:00
nix
platforms/chibios Merge remote-tracking branch 'origin/master' into develop 2021-05-13 02:30:14 +00:00
quantum Fix spelling mistake regarding LED Matrix in split_common. (#12888) 2021-05-14 03:37:24 +10:00
tests
tmk_core Add missing LED Matrix suspend code to suspend.c (#12878) 2021-05-13 11:24:44 +10:00
users Merge remote-tracking branch 'origin/master' into develop 2021-05-14 03:54:43 +00:00
util New command: qmk console (#12828) 2021-05-08 20:56:07 -07: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 fix some references to bin/qmk that slipped in (#12832) 2021-05-08 12:25:04 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk
disable_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk fix some references to bin/qmk that slipped in (#12832) 2021-05-08 12:25:04 -07:00
nose2.cfg
readme.md
requirements-dev.txt New command: qmk console (#12828) 2021-05-08 20:56:07 -07:00
requirements.txt
secrets.tar.enc
setup.cfg
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 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.

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

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.