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.
Annika Backstrom ed7c564bf6 bm16s: add annika's initial keymap 3 weeks ago
.github Tweak issue templates (capitalisation mostly) (#5133) 6 months ago
.vscode Xton's first keymap! (#2941) 1 year ago
bin QMK CLI and JSON keymap support (#6176) 1 month ago
docs Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 4 weeks ago
drivers Refactoring wilba.tech PCBs, updating Rama Works U80-A (#6272) 4 weeks ago
keyboards bm16s: add annika's initial keymap 3 weeks ago
layouts Jotix (#6355) 1 month ago
lib Expand bootloader target to support most AVR boards (#6255) 1 month ago
quantum Refactoring wilba.tech PCBs, updating Rama Works U80-A (#6272) 4 weeks ago
tests Remove empty action_function() 7 months ago
tmk_core Update IS_COMMAND definitions to use MOD_MASK_SHIFT (#6348) 4 weeks ago
users Adding rgb matrix speed into eeprom storage. (#5965) 1 month ago
util Configure Vagrant to use qmk_base_container (#6194) 1 month ago
.clang-format fix indent size 2 months ago
.clang_complete Vim Layout for Ergodox-EZ (mac only) (#2112) 1 year ago
.editorconfig QMK CLI and JSON keymap support (#6176) 1 month ago
.gitattributes Set eep files to binary mode 3 years ago
.gitignore QMK CLI and JSON keymap support (#6176) 1 month ago
.gitmodules Update .gitmodules 1 year ago
.travis.yml Update docker util script and travis to use new base container 1 month ago
CODE_OF_CONDUCT.md Update CODE_OF_CONDUCT.md 1 year ago
Dockerfile Update docker util script and travis to use new base container 1 month ago
Doxyfile Generate API docs from source code comments (#2491) 1 year ago
LICENSE add an explicit lisence file for github to pickup 1 year ago
Makefile Make python a required build dependency (#5784) 3 months ago
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 1 month ago
autocomplete.sh Make arguments redo, subproject elimination (#1784) 1 year ago
book.json adds redirects for docs 2 years ago
bootloader.mk Usbasploader bootloader option addition (#6304) 1 month ago
build_full_test.mk Add SRC and OPT_DEFS when building tests 2 years ago
build_json.mk Fix compiling json files. (#6340) 1 month ago
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 1 month ago
build_layout.mk Add a mechanism for force building a particular community layout (#5027) 6 months ago
build_test.mk Split common.mk into common.mk and common_features.mk 2 years ago
common.mk Move Split Common VPATH addition (#4716) 7 months ago
common_features.mk Use QUANTUM_LIB_SRC for i2c_master.c inclusion (#5617) 1 month ago
doxygen-todo Generate API docs from source code comments (#2491) 1 year ago
license_GPLv2.md Clarify the quantum license (#1042) 2 years ago
license_GPLv3.md Clarify the quantum license (#1042) 2 years ago
license_Modified_BSD.md Clarify the quantum license (#1042) 2 years ago
message.mk Display firmware size percentage (#6307) 1 month ago
readme.md Removes Erez personally from QMK (#5883) 3 months ago
requirements.txt QMK CLI and JSON keymap support (#6176) 1 month ago
secrets.tar.enc update building for .hex, secrets moving 2 years ago
setup.cfg QMK CLI and JSON keymap support (#6176) 1 month ago
shell.nix shell.nix: Downgrade gcc-arm-embedded (#5913) 1 month ago
show_options.mk Add option to enable LTO easily (#5674) 3 months ago
testlist.mk Add basic infrastrucure for building full tests 2 years ago
version.txt Commit changes from config.qmk.fm 3 weeks 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.