kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Linked to template

Browse source
This commit is contained in:
Nicolas Munnich 2024-09-03 13:32:44 +02:00
parent 076694aa82
commit 0683b120ce
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docs/development/module-creation.md
View file

@ -14,7 +14,7 @@ ZMK comes with a Git repository called `zmk-modules` which tracks various differ
## Module Setup ## Module Setup
ZMK has a template to make creating a module easier. Navigate to [the ZMK module template repository](./new-shield.mdx) and select "Use this template" followed by "Create a new repository" in the top right. ZMK has a template to make creating a module easier. Navigate to [the ZMK module template repository](https://github.com/Nick-Munnich/zmk-module-template) and select "Use this template" followed by "Create a new repository" in the top right.
The rest of this page will go through the contents of the template step by step, guiding you through the configuration of the module. The rest of this page will go through the contents of the template step by step, guiding you through the configuration of the module.
@ -61,6 +61,7 @@ Next, you need to define the options to build your module. These also go into `z
- `settings` is a child property containing additional child properties, two of which are particularly relevant: - `settings` is a child property containing additional child properties, two of which are particularly relevant:
- `board_root` points to the parent directory of a `boards` directory, which contains additional board/shield definitions. - `board_root` points to the parent directory of a `boards` directory, which contains additional board/shield definitions.
- `dts_root` points to the parent directory of a `dts` directory, which contains additional devicetree bindings. - `dts_root` points to the parent directory of a `dts` directory, which contains additional devicetree bindings.
- `snippet_root` points to the parent directory of a `snippets` directory, which contains [snippets](https://docs.zephyrproject.org/latest/build/snippets/index.html).
See the `zephyr/module.yml` found in the template for a usage example. See the `zephyr/module.yml` found in the template for a usage example.