Go to file
stanrc85 ca19cd8bb8 remove uneeded returns floating around 2019-04-02 20:33:17 -04:00
.github
.vscode
docs Fix typo in keyboard_post_init_user example, remove EPRM from Persistent Configuration (EEPROM) (#5528) 2019-04-01 11:32:39 -07:00
drivers Fix return value of i2c_readReg and i2c_receive (#5410) 2019-03-15 08:55:07 -07:00
keyboards Use modified rgb_backlight.c file 2019-04-02 19:56:11 -04:00
layouts Fixing dead links (#5503) 2019-03-29 06:20:25 -07:00
lib
quantum Fixing dead links (#5503) 2019-03-29 06:20:25 -07:00
tests
tmk_core build size-check enhancement (#5485) 2019-03-27 08:51:56 -07:00
users remove uneeded returns floating around 2019-04-02 20:33:17 -04:00
util Update build instructions and Dockerfile to download submodules 2019-03-30 10:48:09 -07:00
.clang-format
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile Update build instructions and Dockerfile to download submodules 2019-03-30 10:48:09 -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
build_layout.mk
build_test.mk
common.mk
common_features.mk Next set of split_common changes (#4974) 2019-03-12 10:23:28 -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
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.