Go to file
QMK Bot 59cc10451b
[CI] Format code according to conventions (#26005)
Format code according to conventions
2026-02-11 20:35:16 +00:00
.github Copilot instructions for pull requests (#25857) 2026-01-15 09:19:17 +11:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs Refactor Makefile logic for locating keymaps (#25808) 2025-12-08 19:55:06 +00:00
data Merge remote-tracking branch 'origin/master' into develop 2026-01-13 05:49:36 +00:00
docs [CI] Format code according to conventions (#26000) 2026-02-11 16:06:13 +00:00
drivers Fixes for is31fl3729 LED matrix driver off-by-one errors (#25902) 2026-01-09 15:32:55 -08:00
keyboards [CI] Format code according to conventions (#26005) 2026-02-11 20:35:16 +00:00
layouts Remove deprecated `RGB_` and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib Enforce EOL when formatting files (#24989) 2026-02-11 07:39:49 +08:00
modules/qmk Enable community modules to define LED matrix and RGB matrix effects. (#25187) 2025-05-12 09:30:19 +10:00
platforms Fix flash wear leveling sector calculation (#24776) 2025-12-08 21:58:04 +00:00
quantum [CI] Format code according to conventions (#26000) 2026-02-11 16:06:13 +00:00
tests Merge remote-tracking branch 'origin/master' into develop 2025-11-30 19:25:52 +00:00
tmk_core [CI] Format code according to conventions (#26000) 2026-02-11 16:06:13 +00:00
users Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
util Ignore merge commits on bootstrap testing PRs (#25884) 2025-12-19 02:23:29 +00:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.clangd More compiledb fixes. (#25355) 2025-06-15 11:56:10 +10:00
.editorconfig `.editorconfig`: fix inline comment, tidy name section for yaml (#24416) 2024-09-21 19:48:31 +01:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add `.env`, `.envrc` to gitignore (#25904) 2026-01-03 13:55:17 +00:00
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
Doxyfile Remove `arm_atsam` platform (#24337) 2024-09-02 03:48:17 +01:00
LICENSE
Makefile Refactor Makefile logic for locating keymaps (#25808) 2025-12-08 19:55:06 +00:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk Remove quantum/audio from global VPATH (#18753) 2022-10-20 14:41:45 +01:00
readme.md Branch point for 2026q1 Breaking Change. 2025-12-01 22:48:34 +00:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt Align to latest CLI dependencies (#24553) 2025-03-20 14:04:10 +11:00
setup.cfg Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00

readme.md

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.

Quantum Mechanical Keyboard Firmware

Current Version 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.

Documentation

The docs are powered by VitePress. 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.

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.