Go to file
Joel Challis 2cac8b587f
Remove macos-13 runner from bootstrap testing (#25843)
2025-12-01 12:16:25 +11:00
.github Remove macos-13 runner from bootstrap testing (#25843) 2025-12-01 12:16:25 +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 vite from 5.4.20 to 5.4.21 in /builddefs/docsgen (#25740) 2025-10-21 10:57:34 +01:00
data Refactor `tweetydabird/lotus58` (#25547) 2025-08-17 17:50:59 +01:00
docs QMK CLI Environment bootstrapper (#25038) 2025-11-28 00:36:49 +11:00
drivers [CI] Format code according to conventions (#25827) 2025-11-30 19:25:13 +00:00
keyboards QMK CLI Environment bootstrapper (#25038) 2025-11-28 00:36:49 +11:00
layouts Remove deprecated `RGB_` and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib QMK CLI Environment bootstrapper (#25038) 2025-11-28 00:36:49 +11:00
modules/qmk Enable community modules to define LED matrix and RGB matrix effects. (#25187) 2025-05-12 09:30:19 +10:00
platforms [CI] Format code according to conventions (#25827) 2025-11-30 19:25:13 +00:00
quantum [CI] Format code according to conventions (#25827) 2025-11-30 19:25:13 +00:00
tests [CI] Format code according to conventions (#25827) 2025-11-30 19:25:13 +00:00
tmk_core [CI] Format code according to conventions (#25827) 2025-11-30 19:25:13 +00:00
users Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
util QMK CLI Environment bootstrapper (#25038) 2025-11-28 00:36:49 +11: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 [docs] Replace Imgur-hosted images (#25690) 2025-11-04 00:05:39 +00:00
.gitmodules
Doxyfile Remove `arm_atsam` platform (#24337) 2024-09-02 03:48:17 +01:00
LICENSE
Makefile Remove `DEFAULT_FOLDER` handling (#23281) 2025-06-09 05:08:56 +01:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md Merge point for 2025q3 breaking changes. 2025-09-06 17:54:54 +10: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.