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.
 
 
 
 
Joel Challis 58cd8c366c
Various fixes from reorg of files (#14051)
4 years ago
.github CLI/Docs: Fix the format commands' name (#13668) 4 years ago
.vscode do not automatically format json (#13320) 5 years ago
api_data
bin Ensure that safe_commands always run (#13199) 5 years ago
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 Various fixes from reorg of files (#14051) 4 years ago
layouts Merge remote-tracking branch 'origin/master' into develop 4 years ago
lib `--parallel` improvements (#13800) 4 years ago
nix Update Python dependencies for Nix (#12855) 5 years ago
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 Allow output of logging when running unit tests (#13556) 4 years ago
tmk_core Migrate platform independent code from tmk_core -> quantum (#13673) 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 [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 5 years ago
.gitignore Cleanup gitignore (#13390) 4 years ago
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Merge remote-tracking branch 'origin/master' into develop 4 years ago
Vagrantfile Upgrades Vagrant box to Debian 10 to fix Docker build error on Debian 9. (#13236) 5 years ago
book.json
bootloader.mk Update LUFA (18-07-2021) and add QMK-HID Bootloader support (#13588) 4 years ago
build_full_test.mk
build_json.mk Fixing incorrect keymap build when switching between multiple keymap.jsons (#12632) 5 years ago
build_keyboard.mk Begin to carve out platform/protocol API - Single main loop (#13843) 4 years ago
build_layout.mk Fix building layouts from JSON (#13310) 5 years ago
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 2021 February 27 Breaking Changes Changelog (#11975) 5 years ago
requirements-dev.txt Move hid and pyusb to requirements.txt (#13134) 5 years ago
requirements.txt switch to qmk-dotty-dict (#13460) 4 years ago
secrets.tar.enc
setup.cfg
shell.nix Update Python dependencies for Nix (#12855) 5 years ago
show_options.mk Remove ONEHAND_ENABLE (#13920) 4 years ago
testlist.mk Avoid 8-bit timer overflows in debounce algorithms (#12240) 5 years ago

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.