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.
fauxpark 559ef21563 Add LUFA mass storage `BOOTLOADER` "support" (#7729) 2 years ago
.github Fix typos in stale.yml (#7489) 2 years ago
.vscode Generalize Tap Dance Layer functions (#6629) 2 years ago
bin Add pep8-naming to our python linting 2 years ago
docs Japanese translation of docs/newbs_git_*.md (#7689) 2 years ago
drivers Clean up ISSI driver includes (#7734) 2 years ago
keyboards Add LUFA mass storage `BOOTLOADER` "support" (#7729) 2 years ago
layouts [Keyboard] Clueboard 60 fix col 11 12 mixup (#7685) 2 years ago
lib Also fix flash 2 years ago
quantum Add defaults for f103,f072,f042 (#7704) 2 years ago
tests clang-format changes 2 years ago
tmk_core Add central location for ChibiOS defines (#7542) 2 years ago
users Initial Crkbd layout (#7716) 2 years ago
util Fix install for Linux Ubuntu (#7520) 2 years ago
.clang-format fix indent size 3 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 2 years ago
.gitattributes Set eep files to binary mode 5 years ago
.gitignore [Docs] Update hand wire guide (#7044) 2 years ago
.gitmodules add lufa as a submodule 2 years ago
.travis.yml CI - Fix change detection (#7038) 2 years ago updates the coc 2 years ago
Dockerfile Update docker util script and travis to use new base container 2 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 Allow 'make all:<user>' to not build EVERYTHING (#7402) 2 years ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 2 years ago Make arguments redo, subproject elimination (#1784) 4 years ago
book.json adds redirects for docs 4 years ago Add LUFA mass storage `BOOTLOADER` "support" (#7729) 2 years ago Add SRC and OPT_DEFS when building tests 4 years ago Add JSON keymap to prereq list of C keymap 2 years ago add 'objs-size' target into tmk_core/ (#5490) 2 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 Relocate RGB keycode processing (#7508) 2 years ago
doxygen-todo Remove mbed files (#7605) 2 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 Add list-keymaps make target (#5563) 2 years ago
nose2.cfg Setup a python test framework 2 years ago Improve docs "Edit Document" footer 2 years ago
requirements.txt Add pep8-naming to our python linting 2 years ago
secrets.tar.enc update building for .hex, secrets moving 4 years ago
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 2 years ago
shell.nix Fix shell.nix by pinning nixpkgs (#6213) 2 years ago Add Dip Switch as a core feature (#6140) 2 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 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.