No description
Find a file
diegorodriguezv 65e1afe0af
Correct link in faq_general.md (#25640)
Updated the link to the QMK trademark page.
2025-09-09 19:43:28 -06:00
.github Bump actions/checkout from 4 to 5 (#25554) 2025-09-09 17:40:53 +01:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs Refactor battery driver (#25550) 2025-08-17 01:14:48 +01:00
data Refactor tweetydabird/lotus58 (#25547) 2025-08-17 17:50:59 +01:00
docs Correct link in faq_general.md (#25640) 2025-09-09 19:43:28 -06:00
drivers docs: fix misspellings (#25555) 2025-09-09 14:51:13 -07:00
keyboards [Keyboard] Add the Clog (#23009) 2025-09-09 17:32:59 +01:00
layouts Remove deprecated RGB_ and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib Print build failures with qmk mass-compile and qmk userspace-compile if requested (-p/--print-failures) (#25518) 2025-09-09 17:35:01 +01:00
modules/qmk Enable community modules to define LED matrix and RGB matrix effects. (#25187) 2025-05-12 09:30:19 +10:00
platforms Configure SPI for QMK_PM2040 board (#25481) 2025-07-13 17:00:10 +01:00
quantum Refactor battery driver (#25550) 2025-08-17 01:14:48 +01:00
tests Remove deprecated RGB_ and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
tmk_core docs: fix misspellings (#25555) 2025-09-09 14:51:13 -07:00
users Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
util Add cachyos as pattern when installing dependencies (#25580) 2025-08-25 07:47:28 +10: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 zip to .gitignore (#25483) 2025-07-12 16:56:32 +01: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
doxygen-todo
LICENSE
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
Makefile Remove DEFAULT_FOLDER handling (#23281) 2025-06-09 05:08:56 +01:00
nose2.cfg
paths.mk Remove quantum/audio from global VPATH (#18753) 2022-10-20 14:41:45 +01:00
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 Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00

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.