afiqzudinhadi/zmk
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions
ZMK Firmware Repository https://zmk.dev/
2956 commits 23 branches 7 tags 30 MiB
Find a file
Genteure ff09f2d0c9
docs: reorganise supported hardware page (#3363) 
* docs: supported hardware structure changes

Added a few links to hardware intergration pages to provide clearly signal to reader "you can make your own".
Removed "Contributing" section since it's not really relavent anymore.

* docs: move unsupported boards section out of metadata

* address review comments

* fix broken link

* board variants, interconnect, fix link, move unsupported section

* Apply suggested change

Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com>

---------

Co-authored-by: Nicolas Munnich <98408764+nmunnich@users.noreply.github.com>
2026-06-07 18:45:31 +02:00
.devcontainer feat!: Move to zephyr v4.1 (#3060) 2025-12-09 19:43:22 -05:00
.github chore(deps): bump actions/stale from 10.2.0 to 10.3.0 (#3358) 2026-05-30 19:58:53 +02:00
.vscode Improve VS Code Python settings (#2860) 2025-04-20 04:34:15 -04:00
app docs: reorganise supported hardware page (#3363) 2026-06-07 18:45:31 +02:00
docs docs: reorganise supported hardware page (#3363) 2026-06-07 18:45:31 +02:00
schema feat!: Move to zephyr v4.1 (#3060) 2025-12-09 19:43:22 -05:00
.clang-format feat(ci): Run clang-format to check files. 2020-09-14 00:08:13 -04:00
.gitattributes fix: check out Bash scripts with LF 2020-10-10 17:43:52 -05:00
.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
CODE_OF_CONDUCT.md refactor: Move to new zmk.dev domain name. 2021-06-10 09:27:57 -04:00
CODEOWNERS chore: Initial simple CODEOWNERS. 2021-01-13 20:59:11 -05:00
CONTRIBUTING.md feat(CONTRIBUTING.md): Add info regarding ESLint 2024-03-04 20:08:52 -08:00
LICENSE Updated copyright line. 2020-06-22 05:47:20 -04:00
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.