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