zephyr
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ZMK Firmware Repository
2,902 Commits 23 Branches 7 Tags 120 MiB
C 96.6%
CMake 2.6%
Shell 0.6%
Python 0.2%
Go to file
Nicolas Munnich 590beb3240 docs: Document the new predefined behaviors 
Reorganising the pages of the docs can be done in a followup PR.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
 		2026-02-03 18:37:58 +00: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 docs: Document the new predefined behaviors 2026-02-03 18:37:58 +00:00
docs docs: Document the new predefined behaviors 2026-02-03 18:37:58 +00: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 chore: Initial simple CODEOWNERS. 2021-01-13 20:59:11 -05:00
CODE_OF_CONDUCT.md refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
CONTRIBUTING.md feat(CONTRIBUTING.md): Add info regarding ESLint 2024-03-04 20:08:52 -08:00
LICENSE
…
README.md fix(docs): Fix README punctuation and add license link 2023-07-17 15:23:22 -07:00
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.