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 cb23fe9fc1
Move RGBLight code into its own folder (#13312)
5 years ago
.github
.vscode do not automatically format json (#13320) 5 years ago
api_data
bin
data Optimize our jsonschema by using refs (#13271) 5 years ago
docs Move RGBLight code into its own folder (#13312) 5 years ago
drivers
keyboards Move RGBLight code into its own folder (#13312) 5 years ago
layouts Merge remote-tracking branch 'origin/master' into develop 5 years ago
lib Merge remote-tracking branch 'origin/master' into develop 5 years ago
nix
platforms/chibios
quantum Move RGBLight code into its own folder (#13312) 5 years ago
tests
tmk_core Merge remote-tracking branch 'origin/master' into develop 5 years ago
users
util
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile CLI: Add subcommand to generate version.h (#13151) 5 years ago
Vagrantfile
book.json
bootloader.mk
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk Fix building layouts from JSON (#13310) 5 years ago
build_test.mk
common.mk
common_features.mk Move RGBLight code into its own folder (#13312) 5 years ago
disable_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk
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.