Go to file
zvecr da995d2aea [Docs] Add examples to debugging docs (#5555)
* Add examples to debugging docs

* Add examples to debugging docs - review comments

* Update matrix keypress example to use uprintf
2019-05-03 17:24:07 -07:00
.github Tweak issue templates (capitalisation mostly) (#5133) 2019-02-14 20:44:27 -08:00
.vscode
docs [Docs] Add examples to debugging docs (#5555) 2019-05-03 17:24:07 -07:00
drivers Fixing incorrect usage of RGBLED_NUM in ws2812 driver when used with RGB Matrix (#5744) 2019-05-01 05:48:33 -07:00
keyboards Add DFU Suffix for ARM boards (#5763) 2019-05-03 08:24:22 -07:00
layouts Wanleg tuneup / additions (#5752) 2019-05-01 20:29:00 -07:00
lib Removed forced in lining for lib8tion functions (#5670) 2019-04-29 17:45:42 -07:00
quantum New keycode macro (XP) for shifted character pairs using UNICODEMAP + bug fixes and improvements (#4803) 2019-05-03 09:33:00 -07:00
tests Remove empty action_function() 2019-01-11 18:32:43 -08:00
tmk_core Add DFU Suffix for ARM boards (#5763) 2019-05-03 08:24:22 -07:00
users New keycode macro (XP) for shifted character pairs using UNICODEMAP + bug fixes and improvements (#4803) 2019-05-03 09:33:00 -07:00
util If RGBLIGHT_EFFECT_BREATHE_CENTER is undefined, use fixed breathe table instead of exp() and sin() (#5484) 2019-05-02 07:59:29 -07:00
.clang-format convert to unix line-endings [skip ci] 2019-04-18 23:23:52 +00:00
.clang_complete
.editorconfig Update our style guide (#5500) 2019-04-18 15:59:51 -07:00
.gitattributes
.gitignore Ignore VSCode ipsh folder (#5741) 2019-04-30 09:18:11 -07:00
.gitmodules
.travis.yml Add DFU Suffix for ARM boards (#5763) 2019-05-03 08:24:22 -07:00
CODE_OF_CONDUCT.md
Dockerfile Revert "Update build instructions and docker file to download submodules" (#5533) 2019-04-10 14:15:51 -07:00
Doxyfile
LICENSE
Makefile Shallow clone submodules. (#5279) 2019-03-08 07:58:40 -08:00
Vagrantfile Align docker and vagrant base images (#4905) 2019-03-17 10:36:59 -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 Add a mechanism for force building a particular community layout (#5027) 2019-02-14 20:14:26 -08:00
build_test.mk
common.mk
common_features.mk rgblight 255 hue (#5547) 2019-05-01 08:02:02 -07:00
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk build size-check enhancement (#5485) 2019-03-27 08:51:56 -07:00
readme.md [Docs] Use HTTPS for qmk.fm link (#5506) 2019-04-30 21:54:52 -07: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 Erez Zukerman, 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.