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.
QMK Bot 1327208449 format code according to conventions [skip ci] 2 years ago
.github CI: Add workflow for CLI testing (#7357) 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 Allow 30us matrix delay to be keyboard/user overridable (#8216) 2 years ago
drivers format code according to conventions [skip ci] 2 years ago
keyboards VIA Support: KBD75 rev1/rev2 (#8214) 2 years ago
layouts Code cleanup, use pathlib, use pytest keyboard 2 years ago
lib Use pathlib everywhere we can (#7872) 2 years ago
quantum Add Danish keymap and sendstring LUT (#8218) 2 years ago
tests clang-format changes 2 years ago
tmk_core format code according to conventions [skip ci] 2 years ago
users [Keymap] ninjonas keymap updates (#8170) 2 years ago
util Made windows driver installation accept y as All to allow CI (#8189) 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) 3 years ago
.gitattributes Set eep files to binary mode 5 years ago
.gitignore Remove entries for Minidox eep files from gitignore (#8077) 2 years ago
.gitmodules add lufa as a submodule 2 years ago
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 2 years ago updates the coc 2 years ago
Dockerfile Update docker util script and travis to use new base container 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 Allow 'make all:<user>' to not build EVERYTHING (#7402) 2 years ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 3 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 5 years ago Add JSON keymap to prereq list of C keymap 2 years ago add 'objs-size' target into tmk_core/ (#5490) 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 Relocate grave keycode processing (#8082) 2 years ago
doxygen-todo Remove PJRC USB stack 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 Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 2 years ago
nose2.cfg Setup a python test framework 2 years ago Improve docs "Edit Document" footer 2 years ago
requirements.txt Drop bs4 dependency, update docs, minor improvements 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 Fix AVR boards which were overriding backlight without setting… (#8044) 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.