Go to file
zvecr d8253b83e8 Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
.github
.vscode
docs [Docs] Fix indented subheading on faq_debug.md (#6320) 2019-07-13 13:33:44 -07:00
drivers Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2019-07-09 07:57:14 -07:00
keyboards [Keymap] Fix Comment Styling (#6324) 2019-07-14 19:32:40 -07:00
layouts [Keymap] jotix ortho_4x12 layout match new keycaps (#6209) 2019-06-29 11:22:34 -07:00
lib Spirals, Pinwheels, and Documentation....Oh My! RGB Matrix Effects (#5877) 2019-05-19 09:19:46 -07:00
quantum Switching rgb_config_t to use HSV struct 2019-07-12 07:39:35 -07:00
tests
tmk_core Display firmware size percentage (#6307) 2019-07-11 12:05:13 -07:00
users Switching rgb_config_t to use HSV struct 2019-07-12 07:39:35 -07:00
util Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
.clang-format fix indent size 2019-06-11 01:51:40 -07:00
.clang_complete
.editorconfig Add makeful rules to .editorconfig 2019-07-05 11:35:55 -07:00
.gitattributes
.gitignore
.gitmodules
.travis.yml Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
CODE_OF_CONDUCT.md
Dockerfile Update docker util script and travis to use new base container 2019-07-14 21:01:38 -07:00
Doxyfile
LICENSE
Makefile Make python a required build dependency (#5784) 2019-05-06 10:56:34 -07:00
Vagrantfile Update run command now that the install script is unattended, fix mount point for Debian (#5847) 2019-05-11 17:55:12 -07:00
autocomplete.sh
book.json
bootloader.mk
build_full_test.mk
build_keyboard.mk Fix LIB_SRC insert position (#5731) 2019-05-03 06:20:23 -07:00
build_layout.mk
build_test.mk
common.mk
common_features.mk Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2019-07-09 07:57:14 -07:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Display firmware size percentage (#6307) 2019-07-11 12:05:13 -07:00
readme.md Removes Erez personally from QMK (#5883) 2019-05-15 19:53:45 -04:00
secrets.tar.enc
shell.nix
show_options.mk Add option to enable LTO easily (#5674) 2019-05-02 08:03:42 -07: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 ZSA Technology Labs, the Clueboard by Zach White, and the Atreus by Phil Hagelberg.

Official Website

qmk.fm is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.