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.
 
 
 
 
Alexis Jeandeau b5d24f9efb
Call steno_set_mode inside eeconfig_init_user in the doc (#15176)
4 years ago
.github Auto-create PRs for merged formatting issues (#15157) 4 years ago
.vscode remove Bracket Pair Colorizer recommendation (#14816) 4 years ago
api_data
bin
data Refactor new-keyboard to be python3.7 compatible (#14707) 4 years ago
docs Call steno_set_mode inside eeconfig_init_user in the doc (#15176) 4 years ago
drivers Format code according to conventions (#15193) 4 years ago
keyboards [Keyboard] Move encoder hacks into via keymaps for Work Louder boards (#15192) 4 years ago
layouts [Keymap] Revamp the ergodox french_hacker layout (#15064) 4 years ago
lib Partially reinstate CI formatting process (#15155) 4 years ago
platforms Format code according to conventions (#15193) 4 years ago
quantum Format code according to conventions (#15193) 4 years ago
tests [Core] Fix "6kro enable" and clarify naming (#14563) 4 years ago
tmk_core Format code according to conventions (#15193) 4 years ago
users [Keymap] updates for oled, and diablo 2 layer - Drashna (#15194) 4 years ago
util Cleanup issues identified by lgtm (#14459) 4 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore Align some quantum sub-directories (#14134) 4 years ago
.gitmodules
Dockerfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 4 years ago
Doxyfile
LICENSE
Makefile Allow community layouts to be specified in info.json (#14682) 4 years ago
Vagrantfile move everything from qmkfm/base_container to qmkfm/qmk_cli (#14230) 4 years ago
book.json
bootloader.mk Allow AVR Bootloader size to be configurable (#14783) 4 years ago
build_full_test.mk
build_json.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk Bugfix for Joystick and JSON schema (#14295) 4 years ago
disable_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Move "firmware size check skipped" note to message.mk (#14632) 4 years ago
nose2.cfg
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix Update the nix-shell environment (#13316) 4 years ago
show_options.mk Remove unused KEYBOARD_LOCK_ENABLE from rules (#14920) 4 years ago
testlist.mk

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.