You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
QMK Bot cc14d32941 Merge remote-tracking branch 'origin/master' into develop 5 years ago
.github Use patch bump for auto tagging workflow (#11137) 5 years ago
.vscode
api_data Generate api data on each push (#10609) 5 years ago
bin
docs Merge remote-tracking branch 'origin/master' into develop 5 years ago
drivers Merge remote-tracking branch 'origin/master' into develop 5 years ago
keyboards Merge remote-tracking branch 'origin/master' into develop 5 years ago
layouts Bocaj - Third Annual Refactor (Redux) (#10295) 5 years ago
lib Reduce travis load by replacing an exclusive grep with an inclusive grep (#10964) 5 years ago
platforms/chibios Add default early-init bootloader to F042/F072. (#11120) 5 years ago
quantum Merge remote-tracking branch 'origin/master' into develop 5 years ago
tests
tmk_core gcc 10 compatibility for Drop alt (#9485) 5 years ago
users [Keymap] sneakbox keymap and userspace code (redo) (#10977) 5 years ago
util Merge remote-tracking branch 'origin/master' into develop 5 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore Generate api data on each push (#10609) 5 years ago
.gitmodules
.travis.yml CI: Add docs build and deploy workflow (#7448) 5 years ago
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile 2020 November 28 Breaking Changes Update (#11053) 5 years ago
Vagrantfile
book.json
bootloader.mk Fix STM32duino bootloader (#10648) 5 years ago
build_full_test.mk
build_json.mk
build_keyboard.mk Add board specific to Proton-C, with usual defaults turned on. (#10976) 5 years ago
build_layout.mk
build_test.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
common.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
common_features.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
nose2.cfg
readme.md Branch point for 2021 Feb 27 Breaking Change 5 years ago
requirements-dev.txt
requirements.txt 2020 November 28 Breaking Changes Update (#11053) 5 years ago
secrets.tar.enc
setup.cfg
shell.nix nix-shell: add milc dependency (#11086) 5 years ago
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago
testlist.mk 2020 November 28 Breaking Changes Update (#11053) 5 years ago

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.