Go to file
QMK Bot 1ac030b119 Merge remote-tracking branch 'origin/master' into develop 2021-04-16 14:24:18 +00:00
.github
.vscode
api_data
bin Consistently use bin/qmk when that script is called (#12286) 2021-03-18 16:10:40 -07:00
data Merge remote-tracking branch 'origin/master' into develop 2021-03-24 16:27:28 +00:00
docs Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes (#11935) 2021-04-15 19:32:17 -04:00
drivers Format code according to conventions (#12381) 2021-03-25 23:44:37 +11:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-04-16 14:24:18 +00:00
layouts Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172) 2021-04-12 21:18:52 +02:00
lib Merge remote-tracking branch 'origin/master' into develop 2021-04-15 02:00:59 +00:00
nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
platforms/chibios
quantum Add missing RGB_MODE_TWINKLE / RGB_M_TW keycodes (#11935) 2021-04-15 19:32:17 -04:00
tests
tmk_core LED Matrix: suspend code (#12509) 2021-04-13 19:51:03 +10:00
users Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172) 2021-04-12 21:18:52 +02:00
util Merge remote-tracking branch 'origin/master' into develop 2021-04-15 02:00:59 +00:00
.clang-format
.editorconfig
.gitattributes [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
.gitignore Add support for producing UF2-format binaries. (#12435) 2021-04-06 16:39:15 +10:00
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Add support for producing UF2-format binaries. (#12435) 2021-04-06 16:39:15 +10:00
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 Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172) 2021-04-12 21:18:52 +02:00
disable_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Add support for producing UF2-format binaries. (#12435) 2021-04-06 16:39:15 +10:00
nose2.cfg
readme.md
requirements-dev.txt Remove `wave` from requirements-dev.txt (#12387) 2021-04-03 09:15:39 -07:00
requirements.txt Add support for tab completion (#12411) 2021-04-14 19:00:22 -07:00
secrets.tar.enc
setup.cfg
shell.nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
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.