Fork 0
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.
Gregory Eremin 805cffffcd Allow to disable screen sleep 3 years ago
.vscode Xton's first keymap! (#2941) 4 years ago
docs Allows disabling rgb effects in userspace (#4422) 4 years ago
drivers I2C driver docs (#4298) 4 years ago
keyboards Allow to disable screen sleep 3 years ago
layouts Fix my community layouts (#4449) 4 years ago
lib Revert changes to chibiOS-contrib (#4176) 4 years ago
quantum Allows disabling rgb effects in userspace (#4422) 4 years ago
tests add tests for action_layer.c and reset layer state after tests 5 years ago
tmk_core Use a single endpoint for HID reports (#3951) 4 years ago
users Update to my keymaps and userspace (#4447) 4 years ago
util convert to unix line-endings [skip ci] 4 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 5 years ago
.editorconfig Fix .editorconfig to not mess with line endings 4 years ago
.gitattributes Set eep files to binary mode 6 years ago
.gitignore Ajp10304 (#2719) 4 years ago
.gitmodules Update .gitmodules 5 years ago
.travis.yml Generate API docs from source code comments (#2491) 4 years ago
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 4 years ago
Dockerfile Reverting CMD Changes 5 years ago
Doxyfile Generate API docs from source code comments (#2491) 4 years ago
LICENSE add an explicit lisence file for github to pickup 5 years ago
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 4 years ago
Vagrantfile Update the installation script PR (#4167) 4 years ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 5 years ago
book.json adds redirects for docs 5 years ago
bootloader.mk Add Teensy ++ 2.0 bootloader support 4 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 5 years ago
build_keyboard.mk Fix LAYOUT define generation (#4148) 4 years ago
build_layout.mk Creates a layouts/ folder for keymaps shared between keyboards (#1609) 5 years ago
build_test.mk Split common.mk into common.mk and common_features.mk 5 years ago
common.mk Lets split eh (#3120) 4 years ago
common_features.mk Fix Terminal feature on ChibiOS 4 years ago
doxygen-todo Generate API docs from source code comments (#2491) 4 years ago
license_GPLv2.md Clarify the quantum license (#1042) 5 years ago
license_GPLv3.md Clarify the quantum license (#1042) 5 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 5 years ago
message.mk Treat too-large firmwares as an error, not a warning (#3956) 4 years ago
readme.md Add Atreus as an official board. 4 years ago
secrets.tar.enc update building for .hex, secrets moving 5 years ago
shell.nix Pin avr-gcc in shell.nix pending release of 8.3.0 (#3922) 4 years ago
testlist.mk 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 hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

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 Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

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