Go to file
Ethan Durrant e2ec5790b7 [Docs] updated and cleaned up documentation for Tap Dance (#6949) 2019-10-07 19:28:48 -07:00
.github
.vscode Generalize Tap Dance Layer functions (#6629) 2019-09-21 11:22:27 -07:00
bin Configuration system for CLI (#6708) 2019-09-22 13:25:33 -07:00
docs [Docs] updated and cleaned up documentation for Tap Dance (#6949) 2019-10-07 19:28:48 -07:00
drivers [Keyboard] Added support for ErgoDox with STM32 Microcontroller (#5398) 2019-09-25 11:52:17 -07:00
keyboards [Keymap] katana60: Fix = key in default keymap (#6941) 2019-10-07 17:18:18 -07:00
layouts [Keymap] Community layout for hhkb (#6961) 2019-10-07 13:31:11 -07:00
lib [CLI] Add `qmk list_keyboards` (#6927) 2019-10-07 11:32:30 -07:00
quantum ARM - Initial backlight support (#6487) 2019-10-05 16:57:00 +01:00
tests
tmk_core ARM - Initial backlight support (#6487) 2019-10-05 16:57:00 +01:00
users [Keymap] Overly greedy community keymap build userspace (#6969) 2019-10-07 19:23:59 -07:00
util Port drivers.txt changes from the Toolbox (#6786) 2019-09-30 17:45:44 -07:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore Correct casing for DS_Store in .gitignore (#6787) 2019-09-22 21:32:52 +10:00
.gitmodules
.travis.yml removed deprecated option for Travis (#6896) 2019-10-05 12:04:46 -07:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Add list-keymaps make target (#5563) 2019-09-21 00:00:58 -07:00
Vagrantfile
autocomplete.sh
book.json
bootloader.mk Update bootloader.mk (#6698) 2019-09-18 09:48:58 +10:00
build_full_test.mk
build_json.mk Configuration system for CLI (#6708) 2019-09-22 13:25:33 -07:00
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk ARM - Initial backlight support (#6487) 2019-10-05 16:57:00 +01:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Add list-keymaps make target (#5563) 2019-09-21 00:00:58 -07:00
nose2.cfg
readme.md
requirements.txt Configuration system for CLI (#6708) 2019-09-22 13:25:33 -07:00
secrets.tar.enc
setup.cfg
shell.nix add python3 to shell.nix (#6774) 2019-09-21 11:59:18 -07:00
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 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.