You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
skullydazed a25dd58bc5
QMK CLI and JSON keymap support (#6176)
2 years ago
.github Tweak issue templates (capitalisation mostly) (#5133) 3 years ago
.vscode Xton's first keymap! (#2941) 4 years ago
bin QMK CLI and JSON keymap support (#6176) 2 years ago
docs QMK CLI and JSON keymap support (#6176) 2 years ago
drivers Add GPL3 header to avr i2c files (#6332) 2 years ago
keyboards QMK CLI and JSON keymap support (#6176) 2 years ago
layouts [Keyboard] Add support for XD004 macro keyboard (#6337) 2 years ago
lib QMK CLI and JSON keymap support (#6176) 2 years ago
quantum Switching rgb_config_t to use HSV struct 2 years ago
tests Remove empty action_function() 3 years ago
tmk_core Display firmware size percentage (#6307) 2 years ago
users Switching rgb_config_t to use HSV struct 2 years ago
util QMK CLI and JSON keymap support (#6176) 2 years ago
.clang-format fix indent size 3 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 4 years ago
.editorconfig QMK CLI and JSON keymap support (#6176) 2 years ago
.gitattributes Set eep files to binary mode 5 years ago
.gitignore QMK CLI and JSON keymap support (#6176) 2 years ago
.gitmodules Update .gitmodules 4 years ago
.travis.yml Update docker util script and travis to use new base container 2 years ago
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 3 years ago
Dockerfile Update docker util script and travis to use new base container 2 years ago
Doxyfile Generate API docs from source code comments (#2491) 4 years ago
LICENSE add an explicit lisence file for github to pickup 4 years ago
Makefile Make python a required build dependency (#5784) 3 years ago
Vagrantfile Update run command now that the install script is unattended, fix mount point for Debian (#5847) 3 years ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 4 years ago
book.json adds redirects for docs 4 years ago
bootloader.mk Add Teensy ++ 2.0 bootloader support 4 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 4 years ago
build_json.mk QMK CLI and JSON keymap support (#6176) 2 years ago
build_keyboard.mk QMK CLI and JSON keymap support (#6176) 2 years ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 3 years ago
build_test.mk Split common.mk into common.mk and common_features.mk 5 years ago
common.mk Move Split Common VPATH addition (#4716) 3 years ago
common_features.mk Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 2 years ago
doxygen-todo Generate API docs from source code comments (#2491) 4 years ago
license_GPLv2.md Clarify the quantum license (#1042) 5 years ago
license_GPLv3.md Clarify the quantum license (#1042) 5 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 5 years ago
message.mk Display firmware size percentage (#6307) 2 years ago
readme.md Removes Erez personally from QMK (#5883) 3 years ago
requirements.txt QMK CLI and JSON keymap support (#6176) 2 years ago
secrets.tar.enc update building for .hex, secrets moving 4 years ago
setup.cfg QMK CLI and JSON keymap support (#6176) 2 years ago
shell.nix shell.nix: Packages relocated in upstream cleanup 3 years ago
show_options.mk Add option to enable LTO easily (#5674) 3 years ago
testlist.mk Add basic infrastrucure for building full tests 5 years ago

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.