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

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.