Open-source keyboard firmware for Atmel AVR and Arm USB families
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.
 
 
 
 
Go to file
Ryan d6ce42ae5b
Check for multiple matrix positions assigned to same key (#20039)
16 hours ago
.github Bump actions/stale from 7 to 8 (#20246) 22 hours ago
.vscode Exclude uf2 files in VS Code (#18186) 7 months ago
builddefs Hide hex output when building uf2 (#19940) 4 weeks ago
data Update keycodes_0.0.1_basic.hjson (#20129) 1 week ago
docs [Documentation] Pointing device minor rewrite (#19641) 20 hours ago
drivers Remove usages of config_common.h from config.h files. (#19714) 2 months ago
keyboards Add CannonKeys Bakeneko65 Hotswap ISO PCB to QMK (#20131) 22 hours ago
layouts [Keymap] Drashna updates for 0.20.0 (#19960) 3 weeks ago
lib Check for multiple matrix positions assigned to same key (#20039) 16 hours ago
platforms Add rp2040_ce and add elite-pi and helios as alias (#19830) 1 month ago
quantum Fix processing of recently added system keycodes (#20058) 2 weeks ago
tests VIA Protocol 12 + fixes (#19916) 4 weeks ago
tmk_core Move `KC_MISSION_CONTROL`/`KC_LAUNCHPAD` keycodes to core (#19884) 1 month ago
users [Keymap] crkbd toinux update (#19673) 6 days ago
util Fix regen script for macOS (#19857) 1 month ago
.clang-format Clang-format tweaks (#15906) 1 year ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes eol=lf, where appropriate (#15752) 1 year ago
.gitignore Merge remote-tracking branch 'origin/master' into develop 4 months ago
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 3 months ago
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
Doxyfile Internal docs generation updates (#16411) 1 year ago
LICENSE add an explicit lisence file for github to pickup 5 years ago
Makefile Remove `make all-<platform>` build targets (#19496) 2 months ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 2 years ago
doxygen-todo Remove SERIAL_LINK feature (#14727) 1 year ago
license_GPLv2.md Clarify the quantum license (#1042) 6 years ago
license_GPLv3.md Clarify the quantum license (#1042) 6 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 6 years ago
nose2.cfg Setup a python test framework 4 years ago
paths.mk Remove quantum/audio from global VPATH (#18753) 5 months ago
readme.md Breaking Changes 2023q1 changelog. (#19945) 4 weeks ago
requirements-dev.txt Macros in JSON keymaps (#14374) 1 year ago
requirements.txt Align CLI requirements (#18117) 7 months ago
setup.cfg Quantum Painter (#10174) 12 months ago
shell.nix Nix shell updates for `develop` (#18131) 7 months 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.