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.
 
 
 
 
Jouke Witteveen 2ee573fc5f
led_update_kb -> led_update_ports where appropriate (#18716)
Following #14452, less boilerplate is needed to customize indicator led
control.
3 years ago
.github Bump JamesIves/github-pages-deploy-action from 4.4.0 to 4.4.1 (#18702) 3 years ago
.vscode
builddefs Allow QK_MAKE to work with converters (#18637) 3 years ago
data Merge remote-tracking branch 'origin/master' into develop 3 years ago
docs Programmable Button API refactor and improve docs (#18641) 3 years ago
drivers Make QP driver init functions weak. (#18717) 3 years ago
keyboards led_update_kb -> led_update_ports where appropriate (#18716) 3 years ago
layouts Remove RGBLIGHT_ANIMATION and clean up effect defines for layouts+users (#18729) 3 years ago
lib Merge remote-tracking branch 'origin/master' into develop 3 years ago
platforms Fix some rp2040 hardware ID errors (#18617) 3 years ago
quantum Programmable Button API refactor and improve docs (#18641) 3 years ago
tests Refactor `send_extra` (#18615) 3 years ago
tmk_core LUFA: Consolidate report sending code (#18629) 3 years ago
users Remove RGBLIGHT_ANIMATION and clean up effect defines for layouts+users (#18729) 3 years ago
util Merge remote-tracking branch 'origin/master' into develop 3 years ago
.clang-format
.editorconfig
.gitattributes
.gitignore Remove some .gitignore files (#18689) 3 years ago
.gitmodules
Dockerfile
Doxyfile
LICENSE
Makefile docs: some typos (#18582) 3 years ago
Vagrantfile
doxygen-todo
license_GPLv2.md
license_GPLv3.md
license_Modified_BSD.md
nose2.cfg
paths.mk
readme.md
requirements-dev.txt
requirements.txt
setup.cfg
shell.nix

readme.md

THIS IS THE DEVELOP BRANCH

Warning- This is the develop branch of QMK Firmware. You may encounter broken code here. Please see Breaking Changes for more information.

Quantum Mechanical Keyboard Firmware

Current Version 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 powered by Docsify and hosted on GitHub. They are also viewable offline; see Previewing the Documentation for more details.

You can request changes by making a fork and opening a pull request, or by clicking the "Edit this page" link at the bottom of any page.

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.