You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
yiancar 834fb0b1fe
[Keyboard] Add Argyle (#22607)
11 hours ago
.github Pin actions/labeler to v4 2 days ago
.vscode Far better VSCode intellisense support using clangd. (#20382) 6 months ago
builddefs QMK Userspace (#22222) 1 week ago
data Sort defaults.hjson (#22587) 3 days ago
docs Fixed non-executable codes in the documentation (#22600) 1 day ago
drivers Azoteq IQS5xx support (#22280) 2 weeks ago
keyboards [Keyboard] Add Argyle (#22607) 11 hours ago
layouts Remove userspace keymaps (#22544) 1 week ago
lib Fix more `qmk generate-api` fallout from userspace support (#22619) 21 hours ago
platforms Cater for ECC failures in EFL wear-leveling. (#19749) 1 week ago
quantum New RGB Animations - 4 "Starlight" Animation Variations (#22212) 1 week ago
tests Separate 6KRO and NKRO report structs (#22267) 1 month ago
tmk_core V-USB: implement NKRO (#22398) 1 week ago
users Remove symbolic linked userspace folder (#22548) 1 week ago
util Update macOS install script (#21854) 3 months ago
.clang-format Clang-format tweaks (#15906) 1 year ago
.clangd Far better VSCode intellisense support using clangd. (#20382) 6 months ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes eol=lf, where appropriate (#15752) 1 year ago
.gitignore Flag vial keymaps in 'qmk lint' (#22227) 1 month ago
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 11 months ago
Doxyfile Internal docs generation updates (#16411) 1 year ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile QMK Userspace (#22222) 1 week ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 2 years ago Clarify the quantum license (#1042) 6 years ago Clarify the quantum license (#1042) 6 years ago Clarify the quantum license (#1042) 6 years ago
nose2.cfg Setup a python test framework 4 years ago Remove quantum/audio from global VPATH (#18753) 1 year ago Removed clueboard link as the website has been parked for some time (#22290) 1 month ago
requirements-dev.txt Macros in JSON keymaps (#14374) 2 years ago
requirements.txt Align CLI requirements (#18117) 1 year ago
setup.cfg Quantum Painter (#10174) 1 year ago
shell.nix Nix shell updates for `develop` (#18131) 1 year ago

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.


The docs are powered by Docsify and hosted on GitHub. 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, or by clicking the "Edit this page" link at the bottom of any page.

Supported Keyboards

The project also includes community support for lots of other keyboards.


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 is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.