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.
 
 
 
 
QMK Bot b47bdee93c Merge remote-tracking branch 'origin/master' into develop 4 years ago
.github CI: Create GitHub Actions unit test workflow (#15223) 4 years ago
.vscode remove Bracket Pair Colorizer recommendation (#14816) 4 years ago
api_data
builddefs Add support for deferred executors. (#14859) 4 years ago
data Short term bodge for PRODUCT warning (#15240) 4 years ago
docs Rework encoders to enable asymmetric split keyboards (#12090) 4 years ago
drivers Format code according to conventions (#15193) 4 years ago
keyboards Merge remote-tracking branch 'origin/master' into develop 4 years ago
layouts Require explicit enabling of RGB Matrix modes (#15018) 4 years ago
lib Merge remote-tracking branch 'origin/master' into develop 4 years ago
platforms [Core] RISC-V toolchain and picolibc fixes (#15109) 4 years ago
quantum fix broken macro in transport.h (#15239) 4 years ago
tests Basic keycode overhaul (#14726) 4 years ago
tmk_core [Bug] Fix timer include in override_wiring.c (#15221) 4 years ago
users Merge remote-tracking branch 'origin/master' into develop 4 years ago
util Merge remote-tracking branch 'origin/master' into develop 4 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules Purge uGFX. (#14720) 4 years ago
Dockerfile
Doxyfile
LICENSE
Makefile Migrate makefile utilities to sub-directory (#14917) 4 years ago
Vagrantfile
book.json
build_full_test.mk
build_json.mk
build_keyboard.mk Move tmk_core/common/<plat> (#13918) 4 years ago
build_layout.mk
build_test.mk Rework encoders to enable asymmetric split keyboards (#12090) 4 years ago
common_features.mk Move tmk_core/common/<plat> (#13918) 4 years ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 4 years ago
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk Move tmk_core/common/<plat> (#13918) 4 years ago
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix
testlist.mk Rework encoders to enable asymmetric split keyboards (#12090) 4 years ago

readme.md

Quantum Mechanical Keyboard Firmware

Current Version 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.