keyboard controller firmware for Atmel AVR and ARM USB families
 
 
 
 
 
 
Go to file
Jason Janse van Rensburg 01c72e8dce changed super key to left super key ()
.vscode Add EditorConfig file ()
docs rename api docs to internals
drivers update to driver separation
keyboards changed super key to left super key ()
layouts Update to drashna files ()
lib Merge ChibiOS and LUFA descriptor support ()
quantum add grave to auto-shift.
tests add tests for action_layer.c and reset layer state after tests
tmk_core Better non-Linux support ()
users Update to drashna files ()
util rename api docs to internals
.clang_complete Vim Layout for Ergodox-EZ (mac only) ()
.editorconfig Fix .editorconfig to not mess with line endings
.gitattributes Set eep files to binary mode
.gitignore Generate API docs from source code comments ()
.gitmodules Update .gitmodules
.travis.yml Generate API docs from source code comments ()
CODE_OF_CONDUCT.md create initial code of conduct
Dockerfile Reverting CMD Changes
Doxyfile Generate API docs from source code comments ()
LICENSE add an explicit lisence file for github to pickup
Makefile Added a clean target to remove build artifacts
Vagrantfile Update some obsolete references
autocomplete.sh Make arguments redo, subproject elimination ()
book.json adds redirects for docs
bootloader.mk Updates bootloader settings, adds file size check ()
build_full_test.mk Add SRC and OPT_DEFS when building tests
build_keyboard.mk Merge ChibiOS and LUFA descriptor support ()
build_layout.mk Creates a layouts/ folder for keymaps shared between keyboards ()
build_test.mk Split common.mk into common.mk and common_features.mk
common.mk Start mvoing hardware drivers to /drivers/ ()
common_features.mk Rule to enable Modifiers with Auto-Shift ()
doxygen-todo Generate API docs from source code comments ()
license_GPLv2.md Clarify the quantum license ()
license_GPLv3.md Clarify the quantum license ()
license_Modified_BSD.md Clarify the quantum license ()
message.mk Reset color after submodule warning message
readme.md Found some broken links while looking up ARM keyboard support
secrets.tar.enc update building for .hex, secrets moving
shell.nix shell.nix: add teensy loader
testlist.mk Add basic infrastrucure for building full tests

readme.md

Quantum Mechanical Keyboard Firmware

Current Version Build Status Gitter 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.

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.

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, and the Clueboard by Zach White.

Documentation

https://docs.qmk.fm is 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.