Go to file
QMK Bot 40d1506527 Merge remote-tracking branch 'origin/master' into develop 2021-05-09 20:40:22 +00:00
.github New command: qmk console (#12828) 2021-05-08 20:56:07 -07:00
.vscode
api_data
bin New command: qmk console (#12828) 2021-05-08 20:56:07 -07:00
data Add STM32L433 and L443 support (#12063) 2021-04-26 13:07:15 +10:00
docs New command: qmk console (#12828) 2021-05-08 20:56:07 -07:00
drivers Merge remote-tracking branch 'origin/master' into develop 2021-05-09 17:15:32 +00:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2021-05-09 19:16:57 +00:00
layouts Remove pointless SERIAL_LINK_ENABLE rules (#12846) 2021-05-10 02:53:21 +10:00
lib Merge remote-tracking branch 'origin/master' into develop 2021-05-09 20:40:22 +00: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 (#12772) 2021-05-02 05:15:50 +10:00
tests Missed a couple more `#pragma once`s (#11351) 2020-12-30 15:44:53 +00:00
tmk_core Merge remote-tracking branch 'origin/master' into develop 2021-05-06 16:16:51 +00:00
users Merge remote-tracking branch 'origin/master' into develop 2021-05-08 17:27:30 +00:00
util New command: qmk console (#12828) 2021-05-08 20:56:07 -07: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 CI: Add workflow for codebase formatting (#7382) 2020-12-10 17:01:51 +00:00
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 Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
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 fix some references to bin/qmk that slipped in (#12832) 2021-05-08 12:25:04 -07:00
build_layout.mk
build_test.mk Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00
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 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 fix some references to bin/qmk that slipped in (#12832) 2021-05-08 12:25:04 -07:00
nose2.cfg
readme.md Branch point for 2021 May 29 Breaking Change 2021-02-27 12:54:23 -08:00
requirements-dev.txt New command: qmk console (#12828) 2021-05-08 20:56:07 -07:00
requirements.txt Add support for tab completion (#12411) 2021-04-14 19:00:22 -07:00
secrets.tar.enc
setup.cfg Use the schema to eliminate custom code (#11108) 2021-01-09 13:34:14 -08:00
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 Ensure single newline at EOF for core files (#11310) 2020-12-28 04:36:32 +11:00

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.