Go to file
alex-ong 574fc6444b Whitespace cleanup. 2019-01-26 17:38:52 +11:00
.github
.vscode
docs Whitespace cleanup. 2019-01-26 17:38:52 +11:00
drivers Rename i2c_slave functions so it can coexist with i2c_master (#4875) 2019-01-22 08:57:13 -08:00
keyboards Whitespace cleanup. 2019-01-26 17:38:52 +11:00
layouts rs: code friendly keymap for preonic, iris and my preonic clone (#4303) 2019-01-25 12:57:10 -08:00
lib
quantum Working eager_pk 2019-01-26 17:29:02 +11:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Whitespace cleanup. 2019-01-26 17:38:52 +11:00
users Add personal userspace, update keymaps (#4845) 2019-01-14 09:09:47 -08:00
util
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile Initial fixes for vagrant (#4900) 2019-01-21 10:24:43 -08:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Adds Proton C Conversion (#4661) 2019-01-10 08:22:57 -08:00
build_layout.mk
build_test.mk
common.mk
common_features.mk Whitespace cleanup. 2019-01-26 17:38:52 +11:00
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, 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.