Go to file
Alexander Dang-Tran 73ddb764cc Fix readme and contributing hyperlinks 2018-05-24 00:00:20 -04:00
.vscode
docs Fix readme and contributing hyperlinks 2018-05-24 00:00:20 -04:00
drivers
keyboards config edit for caps indicator (#3016) 2018-05-23 08:27:52 -07:00
layouts Fix led enabled slave (#3022) 2018-05-22 12:40:43 -07:00
lib
quantum Fixed sprintf overflow 2018-05-16 21:05:43 -04:00
tests
tmk_core Fix compile issues for atmega328p 2018-05-20 21:30:14 -07:00
users Add edvorakjp layout for the Iris keyboard (#3020) 2018-05-22 16:59:43 -07:00
util
.clang_complete
.editorconfig
.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 Import userspace config.h according to USER_NAME (#2983) 2018-05-22 12:47:28 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
readme.md
secrets.tar.enc
shell.nix
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, and the Clueboard by Zach White.

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.