适用于 Atmel AVR 和 Arm USB 家族的开源键盘固件 qmk.fm https://qmk.fm/
Go to file
Joel Challis a9efff322c
Some checks failed
Update API Data / api_data (push) Has been cancelled
CLI CI / test (push) Has been cancelled
Update feature branches after develop merge / feature_branch_update (riot) (push) Has been cancelled
Update feature branches after develop merge / feature_branch_update (xap) (push) Has been cancelled
Lint Format / lint (push) Has been cancelled
Regenerate Files / regen (push) Has been cancelled
Unit Tests / test (push) Has been cancelled
Fail when a duplicate module name is detected (#26238)
2026-05-29 20:32:28 +01:00
.github Bump actions/github-script from 8 to 9 (#26142) 2026-04-11 10:15:09 +01:00
.vscode Use relative paths for schemas, instead of $id. Enables VScode validation. (#25251) 2025-05-19 22:10:39 +10:00
builddefs Merge remote-tracking branch 'origin/master' into develop 2026-05-17 03:07:28 +00:00
data [Core] Options to constrain Speculative Hold: SPECULATIVE_HOLD_ONE_KEY and SPECULATIVE_HOLD_FLOW_TERM. (#26099) 2026-05-22 22:50:52 +01:00
docs Merge remote-tracking branch 'origin/master' into develop 2026-05-23 00:39:19 +00:00
drivers Merge remote-tracking branch 'origin/master' into develop 2026-05-26 00:43:27 +00:00
keyboards Add API version assertion for split_data_sync module (#26237) 2026-05-29 07:56:36 +01:00
layouts Remove deprecated RGB_ and Mouse keycodes (#25444) 2025-07-11 11:05:41 -06:00
lib Fail when a duplicate module name is detected (#26238) 2026-05-29 20:32:28 +01:00
modules/qmk Add API version assertion for split_data_sync module (#26237) 2026-05-29 07:56:36 +01:00
platforms fix(ws2812-pwm): allow WS2812_PWM_TICK_FREQUENCY override (#26186) 2026-05-17 00:14:52 +01:00
quantum Mask out active mods when unregistering after retro tapping (#26127) 2026-05-27 00:20:24 +01:00
tests [Core] Options to constrain Speculative Hold: SPECULATIVE_HOLD_ONE_KEY and SPECULATIVE_HOLD_FLOW_TERM. (#26099) 2026-05-22 22:50:52 +01:00
tmk_core Align Mouse USB descriptor (#26230) 2026-05-27 00:43:26 +01:00
users Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
util Merge remote-tracking branch 'origin/master' into develop 2026-04-14 10:03:12 +00: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 .env, .envrc to gitignore (#25904) 2026-01-03 13:55:17 +00: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
doxygen-todo Remove SERIAL_LINK feature (#14727) 2021-10-07 12:32:05 +11:00
LICENSE add an explicit lisence file for github to pickup 2017-11-13 20:50:54 -05: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
Makefile Print correct test names (#26160) 2026-04-19 08:37:12 +08: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 2026q2 Breaking Change 2026-03-08 00:52:03 +00: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

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.