mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-19 20:45:18 -05:00

Go to file

Peter Johanson 291bbc2257 refactor(docs): New shield guide to suggest modules

* Update the new shield guide to position Zephyr module location
  as the default when creating new shields, with a note about
  using ZMK repository itself as a last resort.
* Document building with additional Zephyr modules.

Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>

2023-12-06 09:36:37 -08:00

.devcontainer

chore: Ensure BSIM env. variables set in devcontainer.

2023-12-02 17:11:45 -08:00

.github

feat(build): Build unified config/mod repos.

2023-12-06 09:36:37 -08:00

.vscode

fix: Don't specify default C formatter

2023-05-14 11:54:34 -06:00

app

refactor: Hook into CMake loading in a better spot.

2023-12-06 09:36:37 -08:00

docs

refactor(docs): New shield guide to suggest modules

2023-12-06 09:36:37 -08:00

schema

refactor: Add more checks to pre-commit

2023-04-24 16:07:04 -07: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

add __pycache__ to gitignore now zmk contains python files

2020-11-21 14:47:01 -05:00

.pre-commit-config.yaml

chore: Update Prettier

2023-04-24 16:07:04 -07:00

AUTHORS

Add KemoNine to authors per PeteJohnson

2020-12-07 07:07:45 -05: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

fix: basic setup link

2021-08-12 19:12:30 -05: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

README.md

Zephyr™ Mechanical Keyboard (ZMK) Firmware

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.