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 b16091659c
Move USB Host Shield and Arduino core to `lib/` (#13973)
4 years ago
.github
.vscode
api_data
bin
data Add a lot more data to info.json (#13366) 4 years ago
docs Allow for removal of hysteresis on 4x encoders (#13698) 4 years ago
drivers Relocate platform specific drivers (#13894) 4 years ago
keyboards Merge remote-tracking branch 'origin/master' into develop 4 years ago
layouts Merge remote-tracking branch 'origin/master' into develop 4 years ago
lib Move USB Host Shield and Arduino core to `lib/` (#13973) 4 years ago
nix
platforms Move chibios board files to allow tmk_core platform migration (#13777) 4 years ago
quantum Allow for removal of hysteresis on 4x encoders (#13698) 4 years ago
tests
tmk_core Move USB Host Shield and Arduino core to `lib/` (#13973) 4 years ago
users Merge remote-tracking branch 'origin/master' into develop 4 years ago
util [CLI] Add qmk-hid bootloader detection support to `qmk console` (#14038) 4 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Merge remote-tracking branch 'origin/master' into develop 4 years ago
Vagrantfile
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk Begin to carve out platform/protocol API - Single main loop (#13843) 4 years ago
build_layout.mk
build_test.mk Move print/debug files to quantum (#12069) 4 years ago
common.mk Relocate platform specific drivers (#13894) 4 years ago
common_features.mk Various fixes from reorg of files (#14051) 4 years ago
disable_features.mk
doxygen-todo Various fixes from reorg of files (#14051) 4 years ago
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk `--parallel` improvements (#13800) 4 years ago
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk Remove ONEHAND_ENABLE (#13920) 4 years ago
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.