Go to file
Ryan 37345e2ace
Provide users with replacements for deprecated/invalid functionality where applicable (#17604)
2022-08-06 22:37:40 +10:00
.github
.vscode
builddefs
data Provide users with replacements for deprecated/invalid functionality where applicable (#17604) 2022-08-06 22:37:40 +10:00
docs [Docs] Building with GitHub Userspace (#16271) 2022-08-06 16:36:31 +10:00
drivers
keyboards Move keyboard USB IDs and strings to data driven: Z (#17927) 2022-08-06 18:59:13 +10:00
layouts jotix's community ortho_4x12 layout change (#17891) 2022-08-03 11:32:23 +01:00
lib Provide users with replacements for deprecated/invalid functionality where applicable (#17604) 2022-08-06 22:37:40 +10:00
platforms
quantum
tests
tmk_core
users Userspace: muppetjones (#1) (#13461) 2022-08-03 18:23:17 +01:00
util
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix

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.