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 2a3dd95229
Add basic secure docs (#17577)
3 years ago
.github
.vscode
builddefs
data
docs Add basic secure docs (#17577) 3 years ago
drivers
keyboards Fix layout macro for nightly_boards/paraluman (#17633) 3 years ago
layouts TKL Community Layout Additions (#17563) 3 years ago
lib Add line to multibuild output log showing the actual build target. (#17606) 3 years ago
platforms
quantum Allow for RGB actions to take place on Keydown instead of Keyup (#16886) 3 years ago
tests
tmk_core
users [Userspace] Add support for additional Mechlovin Adelais PCB version to my userspace (#17547) 3 years ago
util MSYS2 install: use MinGW python-qmk package (#17302) 3 years ago
.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.