Go to file
skullY 9e5676650e Use docsfy to replace gitbook 2018-05-07 22:46:26 -07:00
.vscode
docs Use docsfy to replace gitbook 2018-05-07 22:46:26 -07:00
drivers Update whitefox to use the K-Type teensy workaround 2018-04-03 23:06:14 -04:00
keyboards added additional configurator support (#2905) 2018-05-07 08:41:56 -07:00
layouts Update to drashna keymaps and userspace (#2876) 2018-05-02 11:39:46 -04:00
lib Merge ChibiOS and LUFA descriptor support (#2362) 2018-02-08 15:07:46 -05:00
quantum Update to drashna keymaps and userspace (#2876) 2018-05-02 11:39:46 -04:00
tests
tmk_core Add a custom USB driver for ARM (#2750) 2018-04-15 20:42:53 -04:00
users Update to drashna keymaps and userspace (#2876) 2018-05-02 11:39:46 -04:00
util Added archlinux support to linux_install.sh 2018-05-02 11:44:22 -04:00
.clang_complete
.editorconfig Fix .editorconfig to not mess with line endings 2018-02-03 15:20:44 -05:00
.gitattributes
.gitignore Ajp10304 (#2719) 2018-04-15 09:48:19 -07:00
.gitmodules
.travis.yml Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
LICENSE
Makefile Added a clean target to remove build artifacts 2018-03-16 16:44:22 -04:00
Vagrantfile
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Talljoe's layout with common keymap. (#2764) 2018-04-21 10:48:30 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk Fix Audio Clicky sub-feature (#2784) 2018-04-21 12:30:10 -04:00
doxygen-todo Generate API docs from source code comments (#2491) 2018-03-22 02:50:38 -04:00
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk
readme.md add discord link 2018-05-03 15:56:10 -04:00
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.