Go to file
Tim Gröger 35f2976ab2 feat(RGB Matrix)
* add more RGB features
* improve keyboardlayout
2026-05-18 16:04:28 +02:00
.github Bump actions/github-script from 8 to 9 (#26142) 2026-04-11 10:15:09 +01:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs GCC 16.1 compatibility fix. (#26216) 2026-05-17 13:06:47 +10:00
data Allow custom data sync for community modules (#25955) 2026-02-19 22:03:26 +11:00
docs Deploy `qmk_udev` during bootstrap, updated CLI bootstrap docs (#26147) 2026-04-14 11:02:31 +01:00
drivers [CI] Format code according to conventions (#26138) 2026-04-09 13:26:08 +01:00
keyboards feat(RGB Matrix) 2026-05-18 16:04:28 +02:00
layouts Remove deprecated `RGB_` and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib Fix `config.h` bool parsing (#26166) 2026-04-30 23:57:08 +01: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 [CI] Format code according to conventions (#26138) 2026-04-09 13:26:08 +01: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 Deploy `qmk_udev` during bootstrap, updated CLI bootstrap docs (#26147) 2026-04-14 11:02:31 +01: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
LICENSE
Makefile Avoid BrokenPipeError errors in `qmk clean` 2026-04-09 11:30:33 +01:00
compile_keyboard.sh layout for my dactyl 2026-05-18 16:04:27 +02:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
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.