Go to file
QMK Bot fc29068986 Merge remote-tracking branch 'origin/master' into develop 2021-04-29 18:26:09 +00:00
.github fix CI job: api-data->api_data 2021-03-06 21:26:07 -08:00
.vscode
api_data
bin Consistently use bin/qmk when that script is called (#12286) 2021-03-18 16:10:40 -07:00
data Add STM32L433 and L443 support (#12063) 2021-04-26 13:07:15 +10:00
docs Change RGB/LED Matrix to use a simple define for USB suspend (#12697) 2021-04-29 12:39:54 +10:00
drivers Update ADC driver for STM32F1xx, STM32F3xx, STM32F4xx (#12403) 2021-04-25 11:15:37 +10:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-04-29 18:26:09 +00:00
layouts Change `BOOTMAGIC_ENABLE=yes` to use Bootmagic Lite (#12172) 2021-04-12 21:18:52 +02:00
lib Add STM32L433 and L443 support (#12063) 2021-04-26 13:07:15 +10:00
nix [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 2021-04-03 08:05:46 -07:00
platforms/chibios Add STM32L433 and L443 support (#12063) 2021-04-26 13:07:15 +10:00
quantum [CI] Format code according to conventions (#12731) 2021-04-29 13:36:47 +10:00
tests
tmk_core [CI] Format code according to conventions (#12731) 2021-04-29 13:36:47 +10:00
users Merge remote-tracking branch 'origin/master' into develop 2021-04-27 06:45:17 +00:00
util Merge remote-tracking branch 'origin/master' into develop 2021-04-29 16:49:03 +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 Merge remote-tracking branch 'origin/master' into develop 2021-04-26 19:18:51 +00: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 Add initial support for tinyuf2 bootloader (when hosted on F411 blackpill) (#12600) 2021-04-25 13:40:56 +10:00
build_full_test.mk
build_json.mk Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
build_keyboard.mk Begin the process of deprecating bin/qmk in favor of the global cli (#12109) 2021-03-07 19:10:03 -08:00
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 add OLED_DRIVER_ENABLE into show_options.mk (#12121) 2021-03-05 20:26:26 +00: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.