Go to file
Drashna Jaelre 73e92ef0c0 Docs: Add references to One Shot functions, and clean up formatting (#4189)
* Docs: Add references to One Shot functions, and clean up formatting

* Update PR based on @mechmerlin's recommendations
2018-10-27 00:22:47 -04:00
.vscode
docs Docs: Add references to One Shot functions, and clean up formatting (#4189) 2018-10-27 00:22:47 -04:00
drivers Remove all of the deprecated RGB defines 2018-10-22 14:55:57 -04:00
keyboards RGB Support for Panc60 (#4253) 2018-10-26 21:20:00 -07:00
layouts Keymap: Update userspace (I want my Hacktoberfest shirt!) (#4252) 2018-10-26 17:14:50 -07:00
lib Revert changes to chibiOS-contrib (#4176) 2018-10-19 12:42:28 -07:00
quantum add support for encoders to core 2018-10-26 14:24:13 -07:00
tests
tmk_core Add delayed flashing option for DFU Util (#4225) 2018-10-27 00:21:43 -04:00
users Keymap: Update userspace (I want my Hacktoberfest shirt!) (#4252) 2018-10-26 17:14:50 -07:00
util Bug: Users had to be in the /util directory to run the script (#4228) 2018-10-24 08:57:08 -07:00
.clang_complete
.editorconfig
.gitattributes
.gitignore
.gitmodules
.travis.yml
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 2018-08-01 15:20:02 -04:00
Dockerfile
Doxyfile
LICENSE
Makefile improve looks like hang up when first time execute make git-submodule (#3846) 2018-09-10 16:21:54 -07:00
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 Fix LAYOUT define generation (#4148) 2018-10-16 14:14:52 -04:00
build_layout.mk
build_test.mk
common.mk Lets split eh (#3120) 2018-07-16 22:25:02 -04:00
common_features.mk add support for encoders to core 2018-10-26 14:24:13 -07:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Treat too-large firmwares as an error, not a warning (#3956) 2018-09-27 13:32:01 -07:00
readme.md Add Atreus as an official board. 2018-08-16 12:01:34 -04:00
secrets.tar.enc
shell.nix Pin avr-gcc in shell.nix pending release of 8.3.0 (#3922) 2018-09-25 15:16:35 -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 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.