Go to file
Drashna Jaelre cb1e45b4ef Include quantum.h to fix travis CI errors 2018-10-22 21:35:35 -04:00
.vscode
docs Update the installation script PR (#4167) 2018-10-22 13:24:43 -07:00
drivers Remove all of the deprecated RGB defines 2018-10-22 14:55:57 -04:00
keyboards Include quantum.h to fix travis CI errors 2018-10-22 21:35:35 -04:00
layouts Keyboard: initial support for XD87 (#4182) 2018-10-22 14:01:45 -07:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum Keymap: add new keymap (#4127) 2018-10-22 11:54:31 -07:00
tests
tmk_core Keyboard: Port of TMK XT USB Converter (#3619) 2018-10-22 12:37:03 -07:00
users Keymap: Updates to personal userspace and keymaps (#4206) 2018-10-22 13:23:22 -07:00
util adds 'dfu-util' to macos_install.sh 2018-10-22 13:32:47 -07:00
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md
Dockerfile
Doxyfile
LICENSE
Makefile
Vagrantfile Update the installation script PR (#4167) 2018-10-22 13:24:43 -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
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.