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.
Collin J. Doering a592e7b7ce
Modify location of F# keys in lower/raise layers
9 months ago
.github Force "blank" issue template to end of list (#8387) 10 months ago
.vscode Highlight .inc files as .c files (#8496) 10 months ago
bin CLI: More MSYS2 fixes (#8577) 10 months ago
docs add japanese translation (feature part 01) (#8196) 9 months ago
drivers Fix AVR ws2812 when ADDRESS_BASE is non zero (#8646) 9 months ago
keyboards Modify location of F# keys in lower/raise layers 9 months ago
layouts jotix layouts (#8644) 9 months ago
lib Doctor: Add avrdude/dfu-util/dfu-programmer version printing (#8678) 9 months ago
quantum Add Greek keymap (#8636) 9 months ago
tests format code according to conventions [skip ci] 10 months ago
tmk_core format code according to conventions [skip ci] 9 months ago
users [Keymap] sigul Planck layout updates (#8649) 9 months ago
util Miscellaneous cleanups (#8639) 9 months ago
.clang-format fix indent size 1 year ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 3 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 1 year ago
.gitattributes Set eep files to binary mode 4 years ago
.gitignore 2020 February 29 Breaking Changes Update (#8064) 10 months ago
.gitmodules Track master branches for lib/chibios, lib/chibios-contrib, lib/ugfx. (#8273) 10 months ago
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 1 year ago updates the coc 1 year 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 3 years ago
Makefile 2020 February 29 Breaking Changes Update (#8064) 10 months ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 1 year ago Make arguments redo, subproject elimination (#1784) 3 years ago
book.json adds redirects for docs 3 years ago Add LUFA mass storage `BOOTLOADER` "support" (#7729) 1 year ago Add SRC and OPT_DEFS when building tests 3 years ago Rename qmk json-keymap to qmk json2c (#8372) 10 months ago Align some ChibiOS build logic (#8461) 10 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) 10 months ago Move Split Common VPATH addition (#4716) 2 years ago Add Word Per Minute calculation feature (#8054) 10 months ago
doxygen-todo Remove PJRC USB stack 11 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) 11 months ago
nose2.cfg Setup a python test framework 1 year ago Breaking Changes documentation fixes 10 months ago
requirements.txt Drop bs4 dependency, update docs, minor improvements 11 months ago
secrets.tar.enc update building for .hex, secrets moving 3 years ago
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 1 year ago
shell.nix Fix up Arm builds with nix-shell. (#8312) 10 months ago Remove unused LED_BREATHING_TABLE 10 months 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 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.