Go to file
Joel Challis 9d24bc8a33
Fix userspace detection in Makefile (#26117)
2026-03-30 11:24:32 +08:00
.github Detect PRs bypassing DD changes (#26094) 2026-03-20 06:27:49 +11:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs Bump rollup from 4.31.0 to 4.59.0 in /builddefs/docsgen (#26036) 2026-03-09 22:00:42 +00:00
data Allow custom data sync for community modules (#25955) 2026-02-19 22:03:26 +11:00
docs Explain how to use STORE_SETUPS and PRINT_SETUPS (#26070) 2026-03-19 11:40:49 +08:00
drivers Fix pointing device driver typo (#26091) 2026-03-18 18:50:33 -07:00
keyboards [CI] Format code according to conventions (#26108) 2026-03-27 03:56:53 +00:00
layouts Remove deprecated `RGB_` and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib Honor BUILD_DIR in mass_compile.py (#25586) 2026-03-15 22:07:43 +11: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 Extra bootstrap release package filtering. (#26039) 2026-03-12 21:05:24 +11: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 add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Fix userspace detection in Makefile (#26117) 2026-03-30 11:24:32 +08:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
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 Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
paths.mk Remove quantum/audio from global VPATH (#18753) 2022-10-20 14:41:45 +01:00
readme.md Merge point for 2026q1 breaking changes. 2026-03-07 23:47:50 +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

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.