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.
 
 
 
 
QMK Bot c8cff1489a format code according to conventions [skip ci] 5 years ago
.github Update file changes action (#10245) 5 years ago
.vscode [Keyboard] add rhymestone by marksard (#9708) 5 years ago
bin
docs Mark 'key_count' as optional within info.json docs (#10513) 5 years ago
drivers OLED driver fixes (#10377) 5 years ago
keyboards [Keyboard] Add Yugo-M Controller (#10389) 5 years ago
layouts [Keymap] Added 333fred 5x6_5 keymap (#10272) 5 years ago
lib Consolidate udev rules into a single file (#9693) 5 years ago
platforms/chibios
quantum format code according to conventions [skip ci] 5 years ago
tests
tmk_core Add description in Bluetooth docs for requiring NKRO to be disabled (#10359) 5 years ago
users [Keymap] Added 333fred 5x6_5 keymap (#10272) 5 years ago
util MSYS2: Switch to arm-none-eabi-gcc package (#10421) 5 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
book.json
bootloader.mk Add logic for AT90USBxx7 where needed (#10203) 5 years ago
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk quantum/debounce: rename debouncing algorithms (#9564) 5 years ago
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md Revert "Branch point for 2020 Aug 29 Breaking Change" 5 years ago
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.