You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Go to file
Joel Challis d14ef52b80 [Keymap] Update gherkin to use gpio (#6520) 6 years ago
.github
.vscode
bin Use the older `universal_newlines` name instead of `text` (#6506) 6 years ago
docs Improve backlight PWM pin support (#6202) 6 years ago
drivers (OLED) Added support for CR (#6399) 6 years ago
keyboards [Keymap] Update gherkin to use gpio (#6520) 6 years ago
layouts [Keymap] jotix ortho_4x12_layout (#6458) 6 years ago
lib Expand bootloader target to support most AVR boards (#6255) 6 years ago
quantum Enable PWM Support for Planck EZ Indicator Lights (#6473) 6 years ago
tests
tmk_core Fix LT() crashing some ARM keyboards (#6529) 6 years ago
users [Keymap] Adding my userspace and keymaps (#6496) 6 years ago
util Fix qmk_install.sh on Windows dropping to command prompt (#6488) 6 years ago
.clang-format
.clang_complete
.editorconfig QMK CLI and JSON keymap support (#6176) 6 years ago
.gitattributes
.gitignore QMK CLI and JSON keymap support (#6176) 6 years ago
.gitmodules
.travis.yml Update docker util script and travis to use new base container 6 years ago
CODE_OF_CONDUCT.md
Dockerfile Update docker util script and travis to use new base container 6 years ago
Doxyfile
LICENSE
Makefile
Vagrantfile Configure Vagrant to use qmk_base_container (#6194) 6 years ago
autocomplete.sh
book.json
bootloader.mk Usbasploader bootloader option addition (#6304) 6 years ago
build_full_test.mk
build_json.mk Fix compiling json files. (#6340) 6 years ago
build_keyboard.mk add 'objs-size' target into tmk_core/avr.mk (#5490) 6 years ago
build_layout.mk
build_test.mk
common.mk
common_features.mk
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
message.mk Display firmware size percentage (#6307) 6 years ago
readme.md
requirements.txt QMK CLI and JSON keymap support (#6176) 6 years ago
secrets.tar.enc
setup.cfg QMK CLI and JSON keymap support (#6176) 6 years ago
shell.nix shell.nix: Downgrade gcc-arm-embedded (#5913) 6 years ago
show_options.mk
testlist.mk

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.