QuantumMK - qmk.fm personal fork
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Ryan Rix 453e267242 add the aball from https://github.com/brickbots/qmk_firmware/tree/aball/keyboards/handwired/aball 2 years ago
.github Update PR labeler to use pull_request_target (#10695) 3 years ago
.vscode [Keyboard] add rhymestone by marksard (#9708) 3 years ago
bin Move everything to Python 3.6 (#8835) 3 years ago
docs Add last breaking changes log to sidebar (#10680) 3 years ago
drivers [Core] IS31FL3731/36/37 bug fix (#10612) 3 years ago
keyboards add the aball from https://github.com/brickbots/qmk_firmware/tree/aball/keyboards/handwired/aball 2 years ago
layouts Merge remote-tracking branch 'upstream/master' into rr/my-keymaps 3 years ago
lib c2json: Fix TypeError on MSYS2 (#10709) 3 years ago
platforms/chibios Remove unused CORTEX_VTOR_INIT (#10053) 3 years ago
quantum Update keymap_spanish_dvorak.h (#10213) 3 years ago
tests format code according to conventions [skip ci] 3 years ago
tmk_core Added EEPROM emulation for STM32F042x6 series processors (#10685) 3 years ago
users [Keymap] Add Draevin userspace and maps (#10581) 3 years ago
util 50-qmk.rules: Move udev rules from documentation into a file (#10664) 3 years ago
.clang-format fix indent size 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes Set eep files to binary mode 7 years ago
.gitignore Allow for user song list (#9281) 3 years ago
.gitmodules 2020 May 30 Breaking Changes Update (#9215) 3 years ago
.travis.yml Attempt to fix CI for non-master branches. (#9308) 3 years ago
CODE_OF_CONDUCT.md updates the coc 4 years ago
Dockerfile Update docker util script and travis to use new base container 4 years ago
Doxyfile Generate API docs from source code comments (#2491) 5 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile 2020 May 30 Breaking Changes Update (#9215) 3 years ago
Vagrantfile Remove broken example from Makefile (#9159) 3 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk Fix STM32duino bootloader (#10648) 3 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 6 years ago
build_json.mk Load keymap-level rules.mk when compiling keymap.json (#8841) 3 years ago
build_keyboard.mk Initial work for consolidation of ChibiOS platform files (#8327) 3 years ago
build_layout.mk Allow for building layouts from keymap.json files. 3 years ago
build_test.mk Initial arm->chibios pass - simplify some platform logic (#8450) 3 years ago
common.mk Move Split Common VPATH addition (#4716) 4 years ago
common_features.mk Fix RGB matrix for ATmegaxxU2 (#10723) 3 years ago
doxygen-todo Remove iWRAP protocol (#9284) 3 years ago
license_GPLv2.md Clarify the quantum license (#1042) 6 years ago
license_GPLv3.md Clarify the quantum license (#1042) 6 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 6 years ago
message.mk 2020 May 30 Breaking Changes Update (#9215) 3 years ago
nose2.cfg Setup a python test framework 4 years ago
readme.md Revert "Branch point for 2020 Aug 29 Breaking Change" 3 years ago
requirements-dev.txt Use milc for config check, requirements fixes 3 years ago
requirements.txt [CLI] Add c2json (#8817) 3 years ago
secrets.tar.enc update building for .hex, secrets moving 6 years ago
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 4 years ago
shell.nix Update shell.nix (#10712) 3 years ago
show_options.mk Better handle LTO_ENABLE (#9832) 3 years ago
testlist.mk Add basic infrastrucure for building full tests 6 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

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.