Go to file
William Chang dff4f13c19 updated keys and cleaned up readme 2020-01-01 22:31:00 -08:00
.github Add auto-handling of stale PRs/Issues (#7197) 2019-11-20 12:17:52 -08:00
.vscode Generalize Tap Dance Layer functions (#6629) 2019-09-21 11:22:27 -07:00
bin Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
docs Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
drivers Run clang-format manually to fix recently changed files 2019-11-17 08:25:58 -08:00
keyboards updated keys and cleaned up readme 2020-01-01 22:31:00 -08:00
layouts Add info.json files for all default layouts (#7425) 2019-11-20 17:21:23 -08:00
lib Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
quantum [Core] Fix ps2avrgb template (#7412) 2019-11-19 13:00:45 -08:00
tests
tmk_core Run clang-format manually to fix recently changed files 2019-11-17 08:25:58 -08:00
users [Keymap] Add ALGR and kle image, expand and correct documentation (#7426) 2019-11-20 17:25:55 -08:00
util Update ARM GCC on macOS to 8.3 (#7318) 2019-11-13 10:13:27 -08:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore [Docs] Update hand wire guide (#7044) 2019-10-25 11:48:59 -07:00
.gitmodules
.travis.yml CI - Fix change detection (#7038) 2019-11-04 16:18:57 -08:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile Allow 'make all:<user>' to not build EVERYTHING (#7402) 2019-11-20 22:32:16 +00: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 Make generating keymap.c from JSON more reliable 2019-11-12 20:37:28 -08:00
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk [Core] Convert Dynamic Macro to a Core Feature (#5948) 2019-11-04 22:59:13 -08: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 [Docs] Fix missing link in readme (#6958) 2019-10-08 21:59:11 -07:00
requirements.txt Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
secrets.tar.enc
setup.cfg Add flake8 to our test suite and fix all errors (#7379) 2019-11-20 14:54:18 -08:00
shell.nix Fix shell.nix by pinning nixpkgs (#6213) 2019-11-14 12:00:36 -08: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 powered by Docsify and hosted on GitHub. You can request changes by making a fork and pull request, or by clicking the "Edit Document" 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.