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.
 
 
 
 
fauxpark ef8a4e5aaf Remove all references to "CUSTOM_MATRIX" as a diode direction (#7937) 6 years ago
.github
.vscode
bin
docs [Docs] Misc cleanups for OLED documentation (#7864) 6 years ago
drivers Run clang-format manually to fix recently changed files (#7934) 6 years ago
keyboards Remove all references to "CUSTOM_MATRIX" as a diode direction (#7937) 6 years ago
layouts
lib Fix attribute heritance for long commands. 6 years ago
quantum Remove all references to "CUSTOM_MATRIX" as a diode direction (#7937) 6 years ago
tests
tmk_core Remove tmk_core gitignore and gitmodules 6 years ago
users
util Fix unknown key 'IndentPPDirectives' on CI (#7933) 6 years ago
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml Fix unknown key 'IndentPPDirectives' on CI (#7933) 6 years ago
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
testlist.mk

readme.md

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.

Documentation

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.

Maintainers

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.