Go to file
Joel Challis 3dcdf41d1c
Fix split data sync link in community modules docs (#26055)
2026-03-09 21:16:30 +00:00
.github Enable strict linting for keyboard PRs (#26026) 2026-02-20 12:56:19 +00:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs Allow custom data sync for community modules (#25955) 2026-02-19 22:03:26 +11:00
data Allow custom data sync for community modules (#25955) 2026-02-19 22:03:26 +11:00
docs Fix split data sync link in community modules docs (#26055) 2026-03-09 21:16:30 +00:00
drivers Remove redundant unsigned comparison in apa102_set_brightness (#26010) 2026-02-13 12:35:08 +00:00
keyboards Merge remote-tracking branch 'origin/master' into develop 2026-02-13 18:22:34 +00:00
layouts Remove deprecated `RGB_` and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib Merge remote-tracking branch 'origin/master' into develop 2026-02-24 19:23:41 +00:00
modules/qmk Allow custom data sync for community modules (#25955) 2026-02-19 22:03:26 +11:00
platforms Remove deprecated GPIO defines (#26028) 2026-02-20 14:37:16 +00:00
quantum Allow custom data sync for community modules (#25955) 2026-02-19 22:03:26 +11: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
.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
.gitignore Add `.env`, `.envrc` to gitignore (#25904) 2026-01-03 13:55:17 +00:00
.gitmodules
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
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md Merge point for 2026q1 breaking changes. 2026-03-07 23:47:50 +00:00
requirements-dev.txt
requirements.txt Align to latest CLI dependencies (#24553) 2025-03-20 14:04:10 +11:00
setup.cfg

readme.md

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.