Go to file
mechmerlin f8e4921491 update readme 2019-07-14 18:14:00 -07:00
.github
.vscode
docs [Docs] Fix indented subheading on faq_debug.md (#6320) 2019-07-13 13:33:44 -07:00
drivers Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2019-07-09 07:57:14 -07:00
keyboards update readme 2019-07-14 18:14:00 -07:00
layouts [Keymap] jotix ortho_4x12 layout match new keycaps (#6209) 2019-06-29 11:22:34 -07:00
lib
quantum Switching rgb_config_t to use HSV struct 2019-07-12 07:39:35 -07:00
tests
tmk_core Display firmware size percentage (#6307) 2019-07-11 12:05:13 -07:00
users Switching rgb_config_t to use HSV struct 2019-07-12 07:39:35 -07:00
util Switch version incrementing to the command put together by @noroadsleft. (#6310) 2019-07-11 22:33:25 -07:00
.clang-format
.clang_complete
.editorconfig Add makeful rules to .editorconfig 2019-07-05 11:35:55 -07:00
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2019-07-09 07:57:14 -07:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Display firmware size percentage (#6307) 2019-07-11 12:05:13 -07:00
readme.md
secrets.tar.enc
shell.nix
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.