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,916 Commits 20 Branches 7 Tags 118 MiB
C 96.5%
CMake 2.8%
Shell 0.5%
Python 0.2%
Go to file
Pete Johanson a23aa009d7
Add `ZMK_BOARD_COMPAT` symbol, that we can enable for our ZMK variants (#3265) 
feat: Add ZMK_BOARD_COMPAT Kconfig symbol, and check for it

To properly detect users selecting a base board ID, when a ZMK variant
is available, add a ZMK_BOARD_COMPAT Kconfig symbol that the ZMK
variants will enable, allowing us to detect using the bare varand and
warn/error in CI so users don't end up with passing CI that results in
an unusable firmware due to missing ZMK enablement for keyboard name,
settings storage, etc.

refactor(boards): Add ZMK_BOARD_COMPAT to ZMK board variants

To clearly indicate the ZMK board variants are set up for ZMK usage,
select the ZMK_BOARD_COMPAT symbols for them.

fix(boards): Fix pillbug board.yml to report extension

Properly not the ZMK variant is part of an extension of the existing
pillbug board.
 		2026-03-03 10:39:11 -05:00
.devcontainer feat!: Move to zephyr v4.1 (#3060) 2025-12-09 19:43:22 -05:00
.github Add `ZMK_BOARD_COMPAT` symbol, that we can enable for our ZMK variants (#3265) 2026-03-03 10:39:11 -05:00
.vscode Improve VS Code Python settings (#2860) 2025-04-20 04:34:15 -04:00
app Add `ZMK_BOARD_COMPAT` symbol, that we can enable for our ZMK variants (#3265) 2026-03-03 10:39:11 -05:00
docs Add `ZMK_BOARD_COMPAT` symbol, that we can enable for our ZMK variants (#3265) 2026-03-03 10:39:11 -05: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 Add KemoNine to authors per PeteJohnson 2020-12-07 07:07:45 -05:00
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.