Go to file
QMK Bot 93a1d4f156 Merge remote-tracking branch 'origin/master' into develop 2021-02-28 21:25:41 +00:00
.github [CI] Format develop (#11893) 2021-02-15 06:51:07 +11:00
.vscode
api_data
bin Create a system to map between info.json and config.h/rules.mk (#11548) 2021-01-31 12:46:00 -08:00
data Migrate make_dfu_header to CLI (#12061) 2021-02-28 21:25:09 +00:00
docs [Docs] New section to modifier docs: Checking Modifier State (#10550) 2021-02-28 16:42:17 +11:00
drivers Merge branch 'master' into develop 2021-02-14 20:26:22 -05:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-02-28 16:16:16 +00:00
layouts Merge remote-tracking branch 'origin/master' into develop 2021-02-23 13:57:26 -08:00
lib Migrate make_dfu_header to CLI (#12061) 2021-02-28 21:25:09 +00:00
platforms/chibios Add STM32G431 and STM32G474 board definitions. (#11793) 2021-02-06 11:27:46 +11:00
quantum Merge remote-tracking branch 'origin/master' into develop 2021-02-28 20:12:15 +00:00
tests
tmk_core Merge remote-tracking branch 'origin/master' into develop 2021-02-28 21:25:41 +00:00
users [Keymap] Initial commit for keyboardio/atreus/dshields keymap. (#11946) 2021-02-28 17:07:55 +11:00
util Add support for using podman to util/docker_build.sh (#10819) 2021-02-28 15:59:42 +11:00
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
book.json
bootloader.mk Adds AT90USB162 support (#11570) 2021-01-29 19:53:56 -08:00
build_full_test.mk
build_json.mk
build_keyboard.mk Merge remote-tracking branch 'origin/master' into develop 2021-01-30 13:15:13 -08:00
build_layout.mk
build_test.mk
common.mk
common_features.mk Merge remote-tracking branch 'origin/master' into develop 2021-02-28 20:12:15 +00:00
disable_features.mk Add a <FEATURE>_SUPPORTED flag (#9058) 2021-01-30 13:08:58 -08:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md Branch point for 2021 May 29 Breaking Change 2021-02-27 12:54:23 -08:00
requirements-dev.txt Audio system overhaul (#11820) 2021-02-15 09:40:38 +11:00
requirements.txt Create a system to map between info.json and config.h/rules.mk (#11548) 2021-01-31 12:46:00 -08:00
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk Remove FAUXCLICKY feature (deprecated) (#11829) 2021-02-09 09:49:05 -08:00
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.