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
skullY 58d27cf404 Add a note explaining how to run tests 5 years ago
.github Fix typos in stale.yml (#7489) 6 years ago
.vscode Generalize Tap Dance Layer functions (#6629) 6 years ago
bin Add pep8-naming to our python linting 6 years ago
docs Add a note explaining how to run tests 5 years ago
drivers SPI DMA based RGB Underglow for STM32 (#7674) 6 years ago
keyboards [Keyboard] Add Yurei PCB (#7880) 5 years ago
layouts Merlin's LAYOUT_65_ansi keymap (#7879) 5 years ago
lib yapf and style 5 years ago
quantum Relocate common backlight functionally (#7273) 5 years ago
tests
tmk_core chibios/usb_main: re-check USB status in send_keyboard after sleeping the thread (#7784) 5 years ago
users [Keymap] csc027/macro-sync-keymap (#7873) 5 years ago
util Fix docker script and document (#7786) 6 years ago
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml CI - Fix change detection (#7038) 6 years ago
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Allow 'make all:<user>' to not build EVERYTHING (#7402) 6 years ago
Vagrantfile
autocomplete.sh
book.json
bootloader.mk Add LUFA mass storage `BOOTLOADER` "support" (#7729) 6 years ago
build_full_test.mk
build_json.mk Add JSON keymap to prereq list of C keymap 6 years ago
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk Relocate common backlight functionally (#7273) 5 years ago
doxygen-todo Remove mbed files (#7605) 6 years ago
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
nose2.cfg
readme.md Improve docs "Edit Document" footer 6 years ago
requirements.txt Add pep8-naming to our python linting 6 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) 6 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.