Go to file
fauxpark 7797070b37 Merge remote-tracking branch 'upstream/master' into develop 2020-12-18 02:15:28 +11:00
.github Yet another stab at trying to get github actions to push (#11230) 2020-12-16 23:00:02 +00:00
.vscode
api_data Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
bin
docs Add modifier state to the split keyboard transport (#10400) 2020-12-17 16:21:26 +11:00
drivers Merge remote-tracking branch 'upstream/master' into develop 2020-12-18 02:15:28 +11:00
keyboards Merge remote-tracking branch 'upstream/master' into develop 2020-12-18 02:15:28 +11:00
layouts Bocaj - Third Annual Refactor (Redux) (#10295) 2020-12-06 17:30:27 +11:00
lib CLI-ify rgblight_breathing_table_calc.c (#11174) 2020-12-16 14:24:42 +11:00
platforms/chibios Merge remote-tracking branch 'origin/master' into develop 2020-12-11 02:46:19 +00:00
quantum Merge remote-tracking branch 'upstream/master' into develop 2020-12-18 02:15:28 +11:00
tests
tmk_core Merge remote-tracking branch 'upstream/master' into develop 2020-12-18 02:15:28 +11:00
users Selectively enable command and console for yanfali userspace (#11212) 2020-12-14 11:13:00 -08:00
util Merge remote-tracking branch 'upstream/master' into develop 2020-12-18 02:15:28 +11:00
.clang-format
.editorconfig
.gitattributes
.gitignore Generate api data on each push (#10609) 2020-10-25 14:48:44 -07:00
.gitmodules
.travis.yml CI: Add workflow for codebase formatting (#7382) 2020-12-10 17:01:51 +00:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
Vagrantfile
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk Add board specific to Proton-C, with usual defaults turned on. (#10976) 2020-12-03 13:04:28 +11:00
build_layout.mk
build_test.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
common_features.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
nose2.cfg
readme.md Branch point for 2021 Feb 27 Breaking Change 2020-11-30 03:29:39 -08:00
requirements-dev.txt Use milc for config check, requirements fixes 2020-04-08 09:31:14 -07:00
requirements.txt 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
secrets.tar.enc
setup.cfg
shell.nix nix-shell: add milc dependency (#11086) 2020-11-30 21:03:03 +00:00
show_options.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00
testlist.mk 2020 November 28 Breaking Changes Update (#11053) 2020-11-28 12:02:18 -08:00

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.