Skip to content
keyboard controller firmware for Atmel AVR and ARM USB families
Branch: master
Clone or download
Latest commit 3a7c65b May 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tweak issue templates (capitalisation mostly) (#5133) Feb 15, 2019
.vscode Xton's first keymap! (#2941) May 12, 2018
docs fix line endings May 4, 2019
drivers Fixing incorrect usage of RGBLED_NUM in ws2812 driver when used with … May 1, 2019
keyboards [Keyboard] Refactor S60x (#5596) May 4, 2019
layouts [Keymap] add unicode to jotix's ortho_4x12_layout (#5775) May 4, 2019
lib Removed forced in lining for lib8tion functions (#5670) Apr 30, 2019
quantum Fix up ps2avrgb templates (#5606) May 4, 2019
tests Remove empty action_function() Jan 12, 2019
tmk_core Add DFU Suffix for ARM boards (#5763) May 3, 2019
users New keycode macro (XP) for shifted character pairs using UNICODEMAP +… May 3, 2019
util docker_build.sh: Docker requires access to hosts devices (#5063) May 4, 2019
.clang-format convert to unix line-endings [skip ci] Apr 18, 2019
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) Dec 12, 2017
.editorconfig Update our style guide (#5500) Apr 18, 2019
.gitattributes Squashed 'lib/lufa/' changes from 385d403..a44056fb9 Jul 7, 2017
.gitignore Ignore VSCode ipsh folder (#5741) Apr 30, 2019
.gitmodules Update .gitmodules Nov 16, 2017
.travis.yml Add DFU Suffix for ARM boards (#5763) May 3, 2019
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md Aug 1, 2018
Dockerfile Revert "Update build instructions and docker file to download submodu… Apr 10, 2019
Doxyfile Generate API docs from source code comments (#2491) Mar 22, 2018
LICENSE add an explicit lisence file for github to pickup Nov 14, 2017
Makefile Shallow clone submodules. (#5279) Mar 8, 2019
Vagrantfile Align docker and vagrant base images (#4905) Mar 17, 2019
autocomplete.sh Make arguments redo, subproject elimination (#1784) Oct 14, 2017
book.json adds redirects for docs Aug 19, 2017
bootloader.mk Add Teensy ++ 2.0 bootloader support May 9, 2018
build_full_test.mk Add SRC and OPT_DEFS when building tests Jul 20, 2017
build_keyboard.mk Fix LIB_SRC insert position (#5731) May 3, 2019
build_layout.mk Add a mechanism for force building a particular community layout (#5027) Feb 15, 2019
build_test.mk Split common.mk into common.mk and common_features.mk Jun 18, 2017
common.mk Move Split Common VPATH addition (#4716) Dec 31, 2018
common_features.mk rgblight 255 hue (#5547) May 1, 2019
doxygen-todo Generate API docs from source code comments (#2491) Mar 22, 2018
license_GPLv2.md Clarify the quantum license (#1042) Mar 28, 2017
license_GPLv3.md Clarify the quantum license (#1042) Mar 28, 2017
license_Modified_BSD.md Clarify the quantum license (#1042) Mar 28, 2017
message.mk build size-check enhancement (#5485) Mar 27, 2019
readme.md [Docs] Use HTTPS for qmk.fm link (#5506) May 1, 2019
secrets.tar.enc update building for .hex, secrets moving Aug 22, 2017
shell.nix shell.nix: Packages relocated in upstream cleanup Dec 22, 2018
show_options.mk Add option to enable LTO easily (#5674) May 2, 2019
testlist.mk Add basic infrastrucure for building full tests Jun 18, 2017

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.

You can’t perform that action at this time.