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,806 Commits 26 Branches 7 Tags 112 MiB
C 96.5%
CMake 2.7%
Shell 0.6%
Python 0.2%
Go to file
Cem Aksoylar 61325ee82c
docs: Document requirements-extra.txt and endpoint selection for Studio (#3001) 
* docs: Document requirements-extra.txt for Studio builds

* docs: Note endpoint selection requirement for Studio

* docs: Fix indents in list items in native setup page

Add this file to .prettierignore because it messes all the additional indents.
There is also no way to make prettier ignore a range of lines in MDX files AFAICT.

* Revert "docs: Fix indents in list items in native setup page"

This reverts commit 6d8aeba801.
 		2025-07-21 17:11:06 +02:00
.devcontainer docs: Devcontainers-cli enhancement (#2548) 2024-10-27 20:17:41 +01:00
.github fix(ci): pin tj-actions/changed-files due to compromise (#2874) 2025-03-15 02:25:01 -04:00
.vscode Improve VS Code Python settings (#2860) 2025-04-20 04:34:15 -04:00
app fix(ble,hid): Fix smooth scrolling over BLE (#2998) 2025-07-20 09:13:18 -06:00
docs docs: Document requirements-extra.txt and endpoint selection for Studio (#3001) 2025-07-21 17:11:06 +02: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.2.1 (#2851) 2025-03-02 07:45:12 -07:00
AUTHORS Add KemoNine to authors per PeteJohnson 2020-12-07 07:07:45 -05:00
CHANGELOG.md chore(main): release 0.2.1 (#2851) 2025-03-02 07:45:12 -07: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.