No description
Find a file
Charlotte 🦝 Deleńkec 53d319bd71
Some checks failed
Update feature branches after develop merge / feature_branch_update (xap) (push) Has been skipped
Lint Format / lint (push) Failing after 2s
Regenerate Files / regen (push) Failing after 2s
Unit Tests / test (push) Failing after 4s
Update API Data / api_data (push) Has been skipped
CI Build Major Branch / Determine concurrency (push) Has been skipped
CI Build Major Branch / Compile keymap default (push) Has been skipped
CI Build Major Branch / Consolidation (push) Has been skipped
CLI CI / test (push) Failing after 4s
Update feature branches after develop merge / feature_branch_update (riot) (push) Has been skipped
Merge remote-tracking branch 'upstream/develop' into develop
2025-05-04 07:56:47 +01:00
.github Merge remote-tracking branch 'origin/master' into develop 2025-04-23 02:03:39 +00:00
.vscode Far better VSCode intellisense support using clangd. (#20382) 2023-05-14 15:32:34 +10:00
builddefs Merge remote-tracking branch 'origin/master' into develop 2025-04-23 02:26:26 +00:00
data Extend lint checks to reject duplication of defaults (#25149) 2025-04-24 05:39:56 +01:00
docs High resolution scrolling (without feature report parsing) (#24423) 2025-04-23 00:04:31 +02:00
drivers Implement connection keycode logic (#25176) 2025-04-21 22:27:56 +01:00
keyboards Merge remote-tracking branch 'upstream/develop' into develop 2025-05-04 07:56:47 +01:00
layouts Merge remote-tracking branch 'origin/master' into develop 2025-03-20 21:55:29 +00:00
lib Extend lint checks to reject duplication of defaults (#25149) 2025-04-24 05:39:56 +01:00
modules/qmk Add "license" field to Community Module JSON schema. (#25085) 2025-04-01 16:06:42 +11:00
platforms Merge remote-tracking branch 'upstream/develop' into develop 2025-05-04 07:56:47 +01:00
quantum Merge remote-tracking branch 'upstream/develop' into develop 2025-05-04 07:56:47 +01:00
tests [Core] Enhance Flow Tap to work better for rolls over multiple tap-hold keys. (#25200) 2025-04-28 09:52:20 +02:00
tmk_core High resolution scrolling (without feature report parsing) (#24423) 2025-04-23 00:04:31 +02:00
users Add EOL to non-keyboard files (#24990) 2025-03-06 23:17:51 +00:00
util [Core] use keycode_string in unit tests (#25042) 2025-03-21 08:47:22 +01:00
.clang-format Clang-format tweaks (#15906) 2022-02-11 20:00:34 -08:00
.clangd Fix for .clangd. (#25180) 2025-04-22 00:02:47 +10:00
.editorconfig .editorconfig: fix inline comment, tidy name section for yaml (#24416) 2024-09-21 19:48:31 +01:00
.envrc Add i2c split keyboard support for rp2040 2024-04-04 13:47:16 +01:00
.gitattributes eol=lf, where appropriate (#15752) 2022-01-05 21:56:31 +00:00
.gitignore Merge remote-tracking branch 'upstream/develop' into develop 2025-02-02 14:03:34 +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
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 Resolve keyboard_aliases when processing keyboard make targets (#24834) 2025-01-30 06:22:05 +11: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 2025q2 breaking change. 2025-02-28 09:26:13 +11: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
shell.nix Make it work 2024-04-04 13:44:16 +01: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.