zmkfirmware
/
zmk
mirror of https://github.com/zmkfirmware/zmk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ZMK Firmware Repository
2,856 Commits 26 Branches 7 Tags 113 MiB
C 96.5%
CMake 2.7%
Shell 0.6%
Python 0.2%
Go to file
Pete Johanson 8de5b120aa
docs: Add release version to the docs, with links and warning banner (#3122) 
Add versions to the sidebar of the documentation, and when viewing the
deployment on zmk.dev, which tracks `main`, add a banner warning about
possibly prefering the docs for a particular stable release.
 		2025-12-07 03:43:13 -05:00
.devcontainer docs: Devcontainers-cli enhancement (#2548) 2024-10-27 20:17:41 +01:00
.github chore(ci): Set days before issue stale to 1000 (#3022) 2025-08-08 13:13:57 -04:00
.vscode Improve VS Code Python settings (#2860) 2025-04-20 04:34:15 -04:00
app fix(split): int to pointer cast in bas proxy (#3105) 2025-12-07 02:38:05 -05:00
docs docs: Add release version to the docs, with links and warning banner (#3122) 2025-12-07 03:43:13 -05:00
schema feat: Add `studio` as a feature option in metadata 2024-10-17 10:20:30 -06:00
.clang-format
…
.gitattributes
…
.gitignore feat(gitignore): add clangd cache folder 2024-03-27 14:41:26 -07: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 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.