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.
 
 
 
 
 
Jack Humbert fbb056c502 make a5 high when not in use 4 years ago
.github Tweak issue templates (capitalisation mostly) (#5133) 5 years ago
.vscode Xton's first keymap! (#2941) 5 years ago
docs Space Cadet: Reducing unnecessary reported keypresses (#5781) 4 years ago
drivers Fixing incorrect usage of RGBLED_NUM in ws2812 driver when used with RGB Matrix (#5744) 4 years ago
keyboards [Keyboard] Enable RGBLIGHT_ANIMATIONS by default on the Zen rev2 (#5805) 4 years ago
layouts [Keymap] add unicode to jotix's ortho_4x12_layout (#5775) 4 years ago
lib Removed forced in lining for lib8tion functions (#5670) 4 years ago
quantum make a5 high when not in use 4 years ago
tests Remove empty action_function() 5 years ago
tmk_core [Keyboard] Sol keyboard conversion to split common (#5773) 4 years ago
users [Keymap] Update personal userspace and keymaps (now with 4 spaces!) (#5774) 4 years ago
util Make python a required build dependency (#5784) 4 years ago
.clang-format convert to unix line-endings [skip ci] 5 years ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 6 years ago
.editorconfig Update our style guide (#5500) 5 years ago
.gitattributes Set eep files to binary mode 7 years ago
.gitignore Ignore VSCode ipsh folder (#5741) 4 years ago
.gitmodules Update .gitmodules 6 years ago
.travis.yml Add DFU Suffix for ARM boards (#5763) 4 years ago
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 5 years ago
Dockerfile Revert "Update build instructions and docker file to download submodules" (#5533) 5 years ago
Doxyfile Generate API docs from source code comments (#2491) 6 years ago
LICENSE add an explicit lisence file for github to pickup 6 years ago
Makefile Make python a required build dependency (#5784) 4 years ago
Vagrantfile Align docker and vagrant base images (#4905) 5 years ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 6 years ago
book.json adds redirects for docs 6 years ago
bootloader.mk Add Teensy ++ 2.0 bootloader support 5 years ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 6 years ago
build_keyboard.mk Fix LIB_SRC insert position (#5731) 4 years ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 5 years ago
build_test.mk Split common.mk into common.mk and common_features.mk 6 years ago
common.mk Move Split Common VPATH addition (#4716) 5 years ago
common_features.mk rgblight 255 hue (#5547) 4 years ago
doxygen-todo Generate API docs from source code comments (#2491) 6 years ago
license_GPLv2.md Clarify the quantum license (#1042) 7 years ago
license_GPLv3.md Clarify the quantum license (#1042) 7 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 7 years ago
message.mk Make python a required build dependency (#5784) 4 years ago
readme.md [Docs] Use HTTPS for qmk.fm link (#5506) 4 years ago
secrets.tar.enc update building for .hex, secrets moving 6 years ago
shell.nix shell.nix: Packages relocated in upstream cleanup 5 years ago
show_options.mk Add option to enable LTO easily (#5674) 4 years ago
testlist.mk Add basic infrastrucure for building full tests 6 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 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.