Go to file
Nick Brassel 9f04023d35
Decrease firmware size for `anavi/macropad8`. (#25185)
Preparation for bootstrapper.
2025-04-22 14:14:28 +10:00
.github Create tags when `lib/python` changes (#25064) 2025-03-27 06:23:28 +11:00
.vscode
builddefs Bump vite from 5.4.12 to 5.4.15 in /builddefs/docsgen (#25065) 2025-03-28 08:56:08 +00:00
data Fix missing and extra commas in JSON schema (#25057) 2025-04-18 19:05:25 +10:00
docs DOCS: `qmk-hid` missing in bootloaders list? (#25177) 2025-04-20 19:41:30 +10:00
drivers
keyboards Decrease firmware size for `anavi/macropad8`. (#25185) 2025-04-22 14:14:28 +10:00
layouts
lib Fix 'Would you like to clone the submodules?' prompt under msys (#24958) 2025-04-20 08:09:54 +10:00
modules/qmk Fix lockups on AVR with `qmk/hello_world` module (#25074) 2025-03-30 00:19:38 +11:00
platforms Add warning when deprecated 'promicro_rp2040' is used (#25112) 2025-04-08 12:35:43 +10:00
quantum Fix path typo related RP2040 (#25069) 2025-03-28 21:03:59 +11:00
tests
tmk_core
users
util
.clang-format
.clangd Fix for `.clangd`. (#25180) 2025-04-22 00:02:47 +10:00
.editorconfig
.gitattributes
.gitignore
.gitmodules
Doxyfile
LICENSE
Makefile
doxygen-todo
license_GPLv2.md
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
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
requirements-dev.txt
requirements.txt
setup.cfg Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00
shell.nix

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.