No Description

QMK Bot b23a4db47a Merge remote-tracking branch 'origin/master' into develop 5 years ago
.github fdcea06336 CLI/Docs: Fix the format commands' name (#13668) 5 years ago
.vscode 848da57d6e do not automatically format json (#13320) 5 years ago
api_data 0c42f91f4c Generate api data on each push (#10609) 5 years ago
bin 0713797c58 Ensure that safe_commands always run (#13199) 5 years ago
data 2e734fb6b9 Add config.h and rules.mk support for data driven keymaps (#12859) 5 years ago
docs 703f027717 Allow for removal of hysteresis on 4x encoders (#13698) 5 years ago
drivers 1bb7af4d44 Relocate platform specific drivers (#13894) 5 years ago
keyboards b23a4db47a Merge remote-tracking branch 'origin/master' into develop 5 years ago
layouts e80772da40 Merge remote-tracking branch 'origin/master' into develop 5 years ago
lib 2e734fb6b9 Add config.h and rules.mk support for data driven keymaps (#12859) 5 years ago
nix 7ab4902543 Update Python dependencies for Nix (#12855) 5 years ago
platforms 4c9003b177 Move chibios board files to allow tmk_core platform migration (#13777) 5 years ago
quantum 703f027717 Allow for removal of hysteresis on 4x encoders (#13698) 5 years ago
tests fc9fb2c775 Allow output of logging when running unit tests (#13556) 5 years ago
tmk_core b16091659c Move USB Host Shield and Arduino core to `lib/` (#13973) 5 years ago
users e80772da40 Merge remote-tracking branch 'origin/master' into develop 5 years ago
util 85351dc23d [CLI] Add qmk-hid bootloader detection support to `qmk console` (#14038) 5 years ago
.clang-format c3c61dc76e fix indent size 7 years ago
.editorconfig a25dd58bc5 QMK CLI and JSON keymap support (#6176) 7 years ago
.gitattributes d91938c19d [nix] Use niv and poetry2nix to more easily manage dependencies (#11181) 5 years ago
.gitignore 5046883531 Cleanup gitignore (#13390) 5 years ago
.gitmodules fced377ac0 2020 May 30 Breaking Changes Update (#9215) 6 years ago
.travis.yml 6c4b6531fe CI: Add workflow for codebase formatting (#7382) 5 years ago
CODE_OF_CONDUCT.md e243afe23e updates the coc 7 years ago
Dockerfile d8253b83e8 Update docker util script and travis to use new base container 7 years ago
Doxyfile 7c9d5ace14 Generate API docs from source code comments (#2491) 8 years ago
LICENSE 5cdf47a79e add an explicit lisence file for github to pickup 8 years ago
Makefile aabbaf11aa Merge remote-tracking branch 'origin/master' into develop 5 years ago
Vagrantfile 8dc036c2e4 Upgrades Vagrant box to Debian 10 to fix Docker build error on Debian 9. (#13236) 5 years ago
book.json d8145c8464 adds redirects for docs 9 years ago
bootloader.mk 71e9f8fc11 Update LUFA (18-07-2021) and add QMK-HID Bootloader support (#13588) 5 years ago
build_full_test.mk 1b7b72c0e9 Ensure single newline at EOF for core files (#11310) 5 years ago
build_json.mk 2e734fb6b9 Add config.h and rules.mk support for data driven keymaps (#12859) 5 years ago
build_keyboard.mk 2e734fb6b9 Add config.h and rules.mk support for data driven keymaps (#12859) 5 years ago
build_layout.mk 2e734fb6b9 Add config.h and rules.mk support for data driven keymaps (#12859) 5 years ago
build_test.mk 34de7ca224 Move print/debug files to quantum (#12069) 5 years ago
common.mk 1bb7af4d44 Relocate platform specific drivers (#13894) 5 years ago
common_features.mk 58cd8c366c Various fixes from reorg of files (#14051) 5 years ago
disable_features.mk d02c4c5241 Add a <FEATURE>_SUPPORTED flag (#9058) 5 years ago
doxygen-todo 58cd8c366c Various fixes from reorg of files (#14051) 5 years ago
license_GPLv2.md 23839b8c6d Clarify the quantum license (#1042) 9 years ago
license_GPLv3.md 23839b8c6d Clarify the quantum license (#1042) 9 years ago
license_Modified_BSD.md 23839b8c6d Clarify the quantum license (#1042) 9 years ago
message.mk 3b28178deb `--parallel` improvements (#13800) 5 years ago
nose2.cfg 5b7a5b2a76 Setup a python test framework 7 years ago
readme.md e628051505 Restore standard readme 5 years ago
requirements-dev.txt c277ae4768 Move hid and pyusb to requirements.txt (#13134) 5 years ago
requirements.txt ffdfe3798b switch to qmk-dotty-dict (#13460) 5 years ago
secrets.tar.enc c3c07eff51 update building for .hex, secrets moving 9 years ago
setup.cfg 962bc8d9dd Use the schema to eliminate custom code (#11108) 5 years ago
shell.nix 7ab4902543 Update Python dependencies for Nix (#12855) 5 years ago
show_options.mk 7c691d82bf Remove ONEHAND_ENABLE (#13920) 5 years ago
testlist.mk b829a1d264 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.