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.
 
 
 
 
 
Go to file
James Young 71de09d751 Update Breaking Changes doc timeline 5 years ago
.github Fix typos in stale.yml (#7489) 5 years ago
.vscode Generalize Tap Dance Layer functions (#6629) 6 years ago
bin Add pep8-naming to our python linting 5 years ago
docs Update Breaking Changes doc timeline 5 years ago
drivers SPI DMA based RGB Underglow for STM32 (#7674) 5 years ago
keyboards Ensure `PROGMEM` is present on default keymaps (#7836) 5 years ago
layouts Juno (#7652) 5 years ago
lib Also fix flash 5 years ago
quantum RGB matrix effect - left-right gradient (#7742) 5 years ago
tests clang-format changes 6 years ago
tmk_core Move some common matrix code to a common location (#7699) 5 years ago
users Making keymaps based on userspace (#7812) 5 years ago
util Add creation of new keyboard in child directory (#6018) 5 years ago
.clang-format fix indent size 6 years ago
.clang_complete
.editorconfig QMK CLI and JSON keymap support (#6176) 6 years ago
.gitattributes
.gitignore [Docs] Update hand wire guide (#7044) 6 years ago
.gitmodules add lufa as a submodule 6 years ago
.travis.yml CI - Fix change detection (#7038) 6 years ago
CODE_OF_CONDUCT.md updates the coc 6 years ago
Dockerfile Update docker util script and travis to use new base container 6 years ago
Doxyfile
LICENSE
Makefile Allow 'make all:<user>' to not build EVERYTHING (#7402) 6 years ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 6 years ago
autocomplete.sh
book.json
bootloader.mk Add LUFA mass storage `BOOTLOADER` "support" (#7729) 5 years ago
build_full_test.mk
build_json.mk Add JSON keymap to prereq list of C keymap 5 years ago
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 6 years ago
build_layout.mk
build_test.mk
common.mk
common_features.mk Move some common matrix code to a common location (#7699) 5 years ago
doxygen-todo Remove mbed files (#7605) 5 years ago
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Add list-keymaps make target (#5563) 6 years ago
nose2.cfg Setup a python test framework 6 years ago
readme.md Improve docs "Edit Document" footer 5 years ago
requirements.txt Add pep8-naming to our python linting 5 years ago
secrets.tar.enc
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 6 years ago
shell.nix Fix shell.nix by pinning nixpkgs (#6213) 6 years ago
show_options.mk VIA Configurator Refactor (#7268) 5 years ago
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.