Open-source keyboard firmware for Atmel AVR and Arm USB families
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.
KOBAYASHI Yū 542594ef49 Add existing Cannonball Cursorpad files 1 year ago
.github Bump actions/stale from 5 to 6 (#18456) 1 year ago
.vscode Exclude uf2 files in VS Code (#18186) 1 year ago
builddefs Add eeprom defaults for tinyuf2 bootloader (#18042) 1 year ago
data Clean up data driven mappings syntax (#18257) 1 year ago
docs Remove orphan custom functions reference in keymap docs (#18444) 1 year ago
drivers Add led matrix support for CKLED2001 (#17643) 1 year ago
keyboards Add existing Cannonball Cursorpad files 1 year ago
layouts fix: Remove TERM_ON/TERM_OFF from my keymap (#18354) 1 year ago
lib Add ability to remove temporary files during multibuild. (#18381) 1 year ago
platforms Remove non promicro pins from converters (#18239) 1 year ago
quantum Fix int8_t overflow in RGB heatmap effect (#18410) 1 year ago
tests Remove legacy keycodes from unit tests (#18430) 1 year ago
tmk_core GMMK2: Fix 'ISO' within product name (#18322) 1 year ago
users [Keymap] Tune mod tap configuration for dshields home row mods (#18458) 1 year ago
util Install correct package on Fedora (#18243) 1 year ago
.clang-format Clang-format tweaks (#15906) 2 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes eol=lf, where appropriate (#15752) 2 years ago
.gitignore Add .orig to .gitignore (#17626) 1 year ago
.gitmodules [Core] Add Raspberry Pi RP2040 support (#14877) 1 year ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
Doxyfile Internal docs generation updates (#16411) 2 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile Merge remote-tracking branch 'origin/master' into develop 1 year ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 2 years ago Clarify the quantum license (#1042) 7 years ago Clarify the quantum license (#1042) 7 years ago Clarify the quantum license (#1042) 7 years ago
nose2.cfg Setup a python test framework 4 years ago Migrate more makefile utilities to builddefs sub-directory (#16002) 2 years ago 2022q3 Changelog. (#18180) 1 year 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.