Go to file
fauxpark d3bd1d893b Ensure `PROGMEM` is present on default keymaps (#7836) 2020-01-09 10:19:24 +00:00
.github
.vscode
bin
docs RGB matrix effect - left-right gradient (#7742) 2020-01-07 21:25:17 +00:00
drivers SPI DMA based RGB Underglow for STM32 (#7674) 2019-12-31 17:26:40 +00:00
keyboards Ensure `PROGMEM` is present on default keymaps (#7836) 2020-01-09 10:19:24 +00:00
layouts Juno (#7652) 2020-01-07 15:35:08 +11:00
lib
quantum RGB matrix effect - left-right gradient (#7742) 2020-01-07 21:25:17 +00:00
tests
tmk_core Move some common matrix code to a common location (#7699) 2020-01-04 20:29:44 +00:00
users Making keymaps based on userspace (#7812) 2020-01-07 15:36:00 +11:00
util Add creation of new keyboard in child directory (#6018) 2020-01-01 21:07:54 +11:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
autocomplete.sh
book.json
bootloader.mk Add LUFA mass storage `BOOTLOADER` "support" (#7729) 2019-12-29 20:53:23 +00:00
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk Move some common matrix code to a common location (#7699) 2020-01-04 20:29:44 +00:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md Improve docs "Edit Document" footer 2019-12-18 14:01:13 +11:00
requirements.txt
secrets.tar.enc
setup.cfg
shell.nix
show_options.mk VIA Configurator Refactor (#7268) 2020-01-03 12:52:00 -08:00
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.