.vscode Xton's first keymap! (#2941) 1 year ago
docs Docs: Fix descriptions of KC_INT1 and KC_INT3 10 months ago
drivers I2C driver docs (#4298) 8 months ago
keyboards updated 8 months ago
layouts Add to ortho_4x12/buswerks keymap (#4405) 8 months ago
lib updated 8 months ago
quantum modify quantum/template/avr/config.h: add rgblight effect configurations 8 months ago
tests add tests for action_layer.c and reset layer state after tests 1 year ago
tmk_core Add localized LED flash effect on keypress to Massdrop ALT (#4340) 8 months ago
users Update to drashna keymaps (#4365) 8 months ago
util convert to unix line-endings [skip ci] 8 months ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 1 year ago
.editorconfig Fix .editorconfig to not mess with line endings 1 year ago
.gitattributes Squashed 'lib/lufa/' changes from 385d40300..a44056fb9 2 years ago
.gitignore Ajp10304 (#2719) 1 year ago
.gitmodules Update .gitmodules 1 year ago
.travis.yml Generate API docs from source code comments (#2491) 1 year ago Update 11 months ago
Dockerfile Reverting CMD Changes 1 year ago
Doxyfile Generate API docs from source code comments (#2491) 1 year ago
LICENSE add an explicit lisence file for github to pickup 1 year ago
Makefile updated 8 months ago
Vagrantfile Update the installation script PR (#4167) 8 months ago Make arguments redo, subproject elimination (#1784) 1 year ago
book.json adds redirects for docs 1 year ago Add Teensy ++ 2.0 bootloader support 1 year ago Add SRC and OPT_DEFS when building tests 1 year ago Fix LAYOUT define generation (#4148) 9 months ago Creates a layouts/ folder for keymaps shared between keyboards (#1609) 1 year ago Split into and 2 years ago Lets split eh (#3120) 12 months ago Fix Terminal feature on ChibiOS 8 months ago
doxygen-todo Generate API docs from source code comments (#2491) 1 year ago Clarify the quantum license (#1042) 2 years ago Clarify the quantum license (#1042) 2 years ago Clarify the quantum license (#1042) 2 years ago Treat too-large firmwares as an error, not a warning (#3956) 9 months ago Add Atreus as an official board. 11 months ago
secrets.tar.enc update building for .hex, secrets moving 1 year ago
shell.nix Pin avr-gcc in shell.nix pending release of 8.3.0 (#3922) 9 months ago Add basic infrastrucure for building full tests 2 years ago

Quantum Mechanical Keyboard Firmware

Current Version Build Status 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 hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

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 Erez Zukerman, 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.