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.
ai03 e4b91cffea [Keyboard] Add Quasar SSK Controller (#6201) 2 years ago
.github Tweak issue templates (capitalisation mostly) (#5133) 3 years ago
.vscode Xton's first keymap! (#2941) 4 years ago
docs [Docs] Reword confusing description of `TO(layer)` (#6174) 2 years ago
drivers Add SH1106 OLED support (#5787) 3 years ago
keyboards [Keyboard] Add Quasar SSK Controller (#6201) 2 years ago
layouts [Keymap] miryoku layout (#6171) 2 years ago
lib Spirals, Pinwheels, and Documentation....Oh My! RGB Matrix Effects (#5877) 3 years ago
quantum [Keymap] mitosis:datagrok: use non-copyrighted songs, add workman ditty (#6205) 2 years ago
tests Remove empty action_function() 3 years ago
tmk_core Fixes compile errors for massdrop keyboards 3 years ago
users [Keymap] miryoku layout (#6171) 2 years ago
util Install avrdude in Arch/Manjaro Linux (#6132) 3 years ago
.clang-format fix indent size 3 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 4 years ago
.editorconfig Update our style guide (#5500) 3 years ago
.gitattributes Set eep files to binary mode 5 years ago
.gitignore Ignore VSCode ipsh folder (#5741) 3 years ago
.gitmodules Update .gitmodules 4 years ago
.travis.yml Use qmk docker image for travis CI builds 3 years ago Update 3 years ago
Dockerfile upgrade gcc-arm-none-eabi from the default 5.4.1 to 6.3.1 due to ARM runtime issues 3 years ago
Doxyfile Generate API docs from source code comments (#2491) 4 years ago
LICENSE add an explicit lisence file for github to pickup 4 years ago
Makefile Make python a required build dependency (#5784) 3 years ago
Vagrantfile Update run command now that the install script is unattended, fix mount point for Debian (#5847) 3 years ago Make arguments redo, subproject elimination (#1784) 4 years ago
book.json adds redirects for docs 4 years ago Add Teensy ++ 2.0 bootloader support 4 years ago Add SRC and OPT_DEFS when building tests 4 years ago Fix LIB_SRC insert position (#5731) 3 years ago Add a mechanism for force building a particular community layout (#5027) 3 years ago Split into and 5 years ago Move Split Common VPATH addition (#4716) 3 years ago rgblight 255 hue (#5547) 3 years ago
doxygen-todo Generate API docs from source code comments (#2491) 4 years ago Clarify the quantum license (#1042) 5 years ago Clarify the quantum license (#1042) 5 years ago Clarify the quantum license (#1042) 5 years ago Make python a required build dependency (#5784) 3 years ago Removes Erez personally from QMK (#5883) 3 years ago
secrets.tar.enc update building for .hex, secrets moving 4 years ago
shell.nix shell.nix: Packages relocated in upstream cleanup 3 years ago Add option to enable LTO easily (#5674) 3 years ago Add basic infrastrucure for building full tests 5 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 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.