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.
Annika Backstrom c2a28cb42e Code cleanup 1 month ago
.github Update cli CI checkout to v2 (#8823) 2 months ago
.vscode Allow trailing whitespace in markdown docs, for formatting purposes. (#8774) 3 months ago
bin Move everything to Python 3.6 (#8835) 2 months ago
docs Documentation for keymap_extras (#9194) 1 month ago
drivers ISSI driver compile error fix (#9169) 1 month ago
keyboards Code cleanup 1 month ago
layouts [Keymap] dohmain 60_tsangan_hhkb layout (#9157) 1 month ago
lib Fix running qmk info without any arguments (#9218) 1 month ago
quantum Fix build. (#9163) 1 month ago
tests format code according to conventions [skip ci] 4 months ago
tmk_core Fix capitalisation of "GitHub" (#9184) 1 month ago
users Art userspace (#9068) 1 month ago
util CLI: Improve experience when running `qmk setup` on FreeBSD. (#8798) 1 month ago
.clang-format fix indent size 1 year ago
.editorconfig QMK CLI and JSON keymap support (#6176) 1 year ago
.gitattributes Set eep files to binary mode 3 years ago
.gitignore Remove old setup scripts (#8811) 2 months ago
.gitmodules Revert "Fix conflicting types for 'tfp_printf' (#8269)" 2 months ago
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 5 months ago updates the coc 10 months ago
Dockerfile Update docker util script and travis to use new base container 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 2 years ago
Makefile Improve the Makefile message a bit more (#9161) 1 month ago
Vagrantfile Remove broken example from Makefile (#9159) 1 month ago
book.json adds redirects for docs 2 years ago Add LUFA mass storage `BOOTLOADER` "support" (#7729) 6 months ago Add SRC and OPT_DEFS when building tests 3 years ago Load keymap-level when compiling keymap.json (#8841) 2 months ago Align some ChibiOS build logic (#8461) 3 months ago Add a mechanism for force building a particular community layout (#5027) 1 year ago Initial arm->chibios pass - simplify some platform logic (#8450) 3 months ago Move Split Common VPATH addition (#4716) 1 year ago Add SPI 25xx EEPROM support. (#8780) 1 month ago
doxygen-todo Remove Bluefruit protocol (#9008) 2 months 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 Use FIRMWARE_FORMAT for "Checking file size" message (#8121) 5 months ago
nose2.cfg Setup a python test framework 10 months ago Breaking Changes documentation fixes 4 months ago
requirements-dev.txt Use milc for config check, requirements fixes 3 months ago
requirements.txt CLI: Add development mode support 3 months ago
secrets.tar.enc update building for .hex, secrets moving 2 years ago
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 7 months ago
shell.nix Fix up Arm builds with nix-shell. (#8312) 4 months ago Remove unused LED_BREATHING_TABLE 4 months ago Add basic infrastrucure for building full tests 3 years ago
version.txt Commit changes from 1 month 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.