Go to file
alex-ong 123608fb31 DO NOT USE Revert back to original API to support split_keyboards. 2019-01-26 17:10:27 +11:00
.github
.vscode Xton's first keymap! (#2941) 2018-05-12 08:52:11 -07:00
docs DO NOT USE Merge branch 'master' into debounce_refactor 2019-01-26 12:13:19 +11:00
drivers
keyboards Remove accidental xeal60 commit 2019-01-26 16:59:02 +11:00
layouts
lib
quantum
tests
tmk_core
users Add personal userspace, update keymaps (#4845) 2019-01-14 09:09:47 -08:00
util
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml Improve diagnostics for build hashes 2018-12-25 17:09:48 -08:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile
autocomplete.sh
book.json
bootloader.mk Add Teensy ++ 2.0 bootloader support 2018-05-08 20:08:17 -04:00
build_full_test.mk
build_keyboard.mk
build_layout.mk
build_test.mk
common.mk
common_features.mk DO NOT USE - debounce successfully compiled. 2019-01-26 17:03:46 +11:00
doxygen-todo
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md
license_Modified_BSD.md
message.mk
readme.md
secrets.tar.enc
shell.nix shell.nix: Packages relocated in upstream cleanup 2018-12-22 15:09:58 -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.