Jacob/zmk

Go to file

Joel Spadin 82ff6d8e85 docs: update dev env setup guide

Renamed the "Basic Setup" page to "Toolchain Setup" to make it clearer
that this is for setting up a development environment for local builds.

Linked to the relevant Zephyr setup documentation instead of duplicating
that information in our guide. This also switches Windows and macOS
setup to using the Zephyr SDK, which is much easier to install.

Updated the command for installing Zephyr's Python dependencies to be
OS specific, as Windows and macOS don't need the --user flag.

Updated the IDE integration page with instructions for determining the
compiler path that work with the latest version of the Zephyr SDK.

2023-01-19 22:25:10 -05:00

.devcontainer

refactor: Move to Zephyr v3.0.0 + ZMK fixes.

2022-04-03 00:10:29 -04:00

.github

fix(ci): Fix another spot where ` needs escaping.

2023-01-05 12:47:11 -06:00

.vscode

chore: make west scripts more pythonic and apply Black

2022-01-04 23:59:25 -05:00

app

feat(shields): Add splitkb.com Aurora Lily58.

2023-01-06 20:10:53 -06:00

docs

docs: update dev env setup guide

2023-01-19 22:25:10 -05:00

schema

feat(docs): Generate new shield interconnect docs.

2022-12-23 02:41:35 -06: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

fix(pre-commit): use prettier mirror and pin version

2021-02-15 07:43:43 -05: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

refactor: Move to new zmk.dev domain name.

2021-06-10 09:27:57 -04: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.