Go to file
XScorpion2 7d4ae3e66e Removed forced in lining for lib8tion functions (#5670) 2019-04-29 17:45:42 -07:00
.github Tweak issue templates (capitalisation mostly) (#5133) 2019-02-14 20:44:27 -08:00
.vscode
docs Updated rgb_led struct field modifier to flags (#5619) 2019-04-29 15:18:50 -07:00
drivers Removed / replaced questionable logos and added licenses file for safe logos 2019-04-20 08:05:10 -07:00
keyboards [Keyboard] Fixing drag-and-drop (#5728) 2019-04-29 17:29:00 -07:00
layouts Updated rgb_led struct field modifier to flags (#5619) 2019-04-29 15:18:50 -07:00
lib Removed forced in lining for lib8tion functions (#5670) 2019-04-29 17:45:42 -07:00
quantum Updated rgb_led struct field modifier to flags (#5619) 2019-04-29 15:18:50 -07:00
tests
tmk_core Updated rgb_led struct field modifier to flags (#5619) 2019-04-29 15:18:50 -07:00
users [Keymap] Fix my userspace RGB bug (#5686) 2019-04-22 21:52:05 -07:00
util A better new_project.sh (#5191) 2019-04-27 16:42:16 -07:00
.clang-format convert to unix line-endings [skip ci] 2019-04-18 23:23:52 +00:00
.clang_complete
.editorconfig Update our style guide (#5500) 2019-04-18 15:59:51 -07:00
.gitattributes
.gitignore
.gitmodules
.travis.yml Travis CI - skip unit tests for documentation changes (#5267) 2019-04-19 13:20:02 -07:00
CODE_OF_CONDUCT.md
Dockerfile Revert "Update build instructions and docker file to download submodules" (#5533) 2019-04-10 14:15:51 -07:00
Doxyfile
LICENSE
Makefile Shallow clone submodules. (#5279) 2019-03-08 07:58:40 -08:00
Vagrantfile Align docker and vagrant base images (#4905) 2019-03-17 10:36:59 -07:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Change split_common to use RGBLIGHT_SPLIT (#5509) 2019-04-19 15:25:08 -07:00
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
build_test.mk
common.mk
common_features.mk RGB Matrix: Custom effects on a kb/user level (#5338) 2019-04-29 14:48:41 -07:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk build size-check enhancement (#5485) 2019-03-27 08:51:56 -07:00
readme.md
secrets.tar.enc
shell.nix
show_options.mk Clean up debounce a bit (#5255) 2019-03-04 07:44:46 -08:00
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 Erez Zukerman, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official website

http://qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.