ZMK Firmware Repository
Go to file
Nicolas Munnich 340e35c461
docs: Add redirect setup script informing users to switch to ZMK CLI (#3168)
2025-12-29 10:26:00 -08:00
.devcontainer feat!: Move to zephyr v4.1 (#3060) 2025-12-09 19:43:22 -05:00
.github chore(ci): Add warning about being on main branch when build fails (#3159) 2025-12-22 23:05:23 +00:00
.vscode Improve VS Code Python settings (#2860) 2025-04-20 04:34:15 -04:00
app feat(shields): Add Studio support to boardsource3x4 (#3154) 2025-12-28 08:32:42 +00:00
docs docs: Add redirect setup script informing users to switch to ZMK CLI (#3168) 2025-12-29 10:26:00 -08:00
schema feat!: Move to zephyr v4.1 (#3060) 2025-12-09 19:43:22 -05:00
.clang-format
.gitattributes
.gitignore fix: Add "optional" folder to .gitignore (#3141) 2025-12-13 17:37:14 -06:00
.gitlint ci: Add gitlint and document commit conventions 2024-11-12 18:39:27 -07:00
.pre-commit-config.yaml chore(docs): Fix prettier warnings (#2952) 2025-06-01 12:02:39 -07:00
.release-please-manifest.json chore(main): release 0.3.0 (#2858) 2025-08-01 18:44:20 -04:00
AUTHORS
CHANGELOG.md chore(main): release 0.3.0 (#2858) 2025-08-01 18:44:20 -04:00
CODEOWNERS
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
release-please-config.json feat(ci): Add release-please automation with VERSION (#2622) 2024-11-18 16:46:26 -05:00

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

Discord Build Contributor Covenant

ZMK Firmware is an open source (MIT) keyboard firmware built on the Zephyr™ Project Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.

Check out the website to learn more: https://zmk.dev/.

You can also come join our ZMK Discord Server.

To review features, check out the feature overview. ZMK is under active development, and new features are listed with the enhancement label in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.