You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Nikita Titov 3e20697a33 removed deprecated option for Travis (#6896) 4 years ago
.github Tweak issue templates (capitalisation mostly) (#5133) 5 years ago
.vscode Generalize Tap Dance Layer functions (#6629) 4 years ago
bin Configuration system for CLI (#6708) 4 years ago
docs ARM - Initial backlight support (#6487) 4 years ago
drivers [Keyboard] Added support for ErgoDox with STM32 Microcontroller (#5398) 4 years ago
keyboards [Keymap] dz60 Iso de 5x1u split right shift (#6889) 4 years ago
layouts [Keymap] Use 75_ansi and community layout for xd84 (#6821) 4 years ago
lib Fix qmk doctor 'bytes-like object is required' on linux 4 years ago
quantum ARM - Initial backlight support (#6487) 4 years ago
tests clang-format changes 4 years ago
tmk_core ARM - Initial backlight support (#6487) 4 years ago
users Update personal userspace and keymaps (#6876) 4 years ago
util Port drivers.txt changes from the Toolbox (#6786) 4 years ago
.clang-format fix indent size 4 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 6 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 4 years ago
.gitattributes Set eep files to binary mode 7 years ago
.gitignore Correct casing for DS_Store in .gitignore (#6787) 4 years ago
.gitmodules add lufa as a submodule 4 years ago
.travis.yml removed deprecated option for Travis (#6896) 4 years ago
CODE_OF_CONDUCT.md updates the coc 4 years ago
Dockerfile Update docker util script and travis to use new base container 4 years ago
Doxyfile Generate API docs from source code comments (#2491) 6 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile Add list-keymaps make target (#5563) 4 years ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 4 years ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 6 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk Update bootloader.mk (#6698) 4 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 6 years ago
build_json.mk Configuration system for CLI (#6708) 4 years ago
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 4 years ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 5 years ago
build_test.mk Split common.mk into common.mk and common_features.mk 6 years ago
common.mk Move Split Common VPATH addition (#4716) 5 years ago
common_features.mk ARM - Initial backlight support (#6487) 4 years ago
doxygen-todo Generate API docs from source code comments (#2491) 6 years ago
license_GPLv2.md Clarify the quantum license (#1042) 7 years ago
license_GPLv3.md Clarify the quantum license (#1042) 7 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 7 years ago
message.mk Add list-keymaps make target (#5563) 4 years ago
nose2.cfg Setup a python test framework 4 years ago
readme.md Merge point for 2019 Aug 30 Breaking Change 4 years ago
requirements.txt Configuration system for CLI (#6708) 4 years ago
secrets.tar.enc update building for .hex, secrets moving 6 years ago
setup.cfg QMK CLI and JSON keymap support (#6176) 4 years ago
shell.nix add python3 to shell.nix (#6774) 4 years ago
show_options.mk Add Dip Switch as a core feature (#6140) 4 years ago
testlist.mk Add basic infrastrucure for building full tests 6 years ago

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 hosted on Gitbook and GitHub (they are synced). You can request changes by making a fork and pull request, or by clicking the "suggest an edit" link on any page of the docs.

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.