Go to file
Joel Challis f4068dbfb0
Update STM32F446 default HSE to 8MHz (#25717)
2025-10-13 06:40:45 +01:00
.github Add 'xap' branch to CI workflow and options (#25708) 2025-10-07 16:20:39 +11:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs Bump vite from 5.4.19 to 5.4.20 in /builddefs/docsgen (#25646) 2025-09-11 11:12:40 +01:00
data add durgod venus iso support (#25526) 2025-10-06 17:26:16 +01:00
docs [QP] Minor cleanup and support for RGB888 surface (#25706) 2025-10-07 19:10:38 -07:00
drivers [QP] Minor cleanup and support for RGB888 surface (#25706) 2025-10-07 19:10:38 -07:00
keyboards Update STM32F446 default HSE to 8MHz (#25717) 2025-10-13 06:40:45 +01:00
layouts Remove deprecated `RGB_` and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib Add generic handling to cycle LED/RGB Matrix flags (#24649) 2025-09-22 00:01:23 +01:00
modules/qmk Enable community modules to define LED matrix and RGB matrix effects. (#25187) 2025-05-12 09:30:19 +10:00
platforms Update STM32F446 default HSE to 8MHz (#25717) 2025-10-13 06:40:45 +01:00
quantum [QP] Minor cleanup and support for RGB888 surface (#25706) 2025-10-07 19:10:38 -07:00
tests Remove deprecated `RGB_` and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
tmk_core docs: fix misspellings (#25555) 2025-09-09 14:51:13 -07:00
users Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
util Align `drivers.txt` to qmk_toolbox (#25713) 2025-10-10 23:17:27 +01:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.clangd More compiledb fixes. (#25355) 2025-06-15 11:56:10 +10:00
.editorconfig `.editorconfig`: fix inline comment, tidy name section for yaml (#24416) 2024-09-21 19:48:31 +01:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Add zip to .gitignore (#25483) 2025-07-12 16:56:32 +01:00
.gitmodules [Core] Quantum Painter - LVGL Integration (#18499) 2022-12-13 07:51:14 +11:00
Doxyfile Remove `arm_atsam` platform (#24337) 2024-09-02 03:48:17 +01:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05:00
Makefile Remove `DEFAULT_FOLDER` handling (#23281) 2025-06-09 05:08:56 +01:00
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
license_GPLv2.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_GPLv3.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
license_Modified_BSD.md Clarify the quantum license (#1042) 2017-03-28 15:20:36 -07:00
nose2.cfg Setup a python test framework 2019-09-07 07:58:41 -07:00
paths.mk Remove quantum/audio from global VPATH (#18753) 2022-10-20 14:41:45 +01:00
readme.md Branch point for 2025q4 breaking changes 2025-09-06 17:57:39 +10:00
requirements-dev.txt Macros in JSON keymaps (#14374) 2021-11-22 11:11:35 -08:00
requirements.txt Align to latest CLI dependencies (#24553) 2025-03-20 14:04:10 +11:00
setup.cfg Quantum Painter (#10174) 2022-04-13 18:00:18 +10:00

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 VitePress. 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.

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.