commit cfbdb4baabb2a1a3220cc0b92bb55ca432c51e83 Author: Daniel Bauer <4690162+dnlbauer@users.noreply.github.com> Date: Sun May 25 16:12:04 2025 +0200 Initial commit diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..e69de29 diff --git a/Kconfig b/Kconfig new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..38b56e7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 The ZMK Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..100a029 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# ZMK Module Template + +This repository contains a template for a ZMK module, as it would most frequently be used. + +## Usage + +Read through the [ZMK Module Creation](https://zmk.dev/docs/development/module-creation) page for details on how to configure this template. + +## More Info + +For more info on modules, you can read through through the [Zephyr modules page](https://docs.zephyrproject.org/3.5.0/develop/modules.html) and [ZMK's page on using modules](https://zmk.dev/docs/features/modules). [Zephyr's west manifest page](https://docs.zephyrproject.org/3.5.0/develop/west/manifest.html#west-manifests) may also be of use. diff --git a/boards/arm/.gitkeep b/boards/arm/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/boards/shields/.gitkeep b/boards/shields/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/dts/.gitkeep b/dts/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/include/.gitkeep b/include/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/snippets/.gitkeep b/snippets/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/src/.gitkeep b/src/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/west.yml b/west.yml new file mode 100644 index 0000000..270e112 --- /dev/null +++ b/west.yml @@ -0,0 +1,11 @@ +manifest: + remotes: + - name: remote-name + url-base: https://github.com/remote-name + projects: + # Together with the above defined remote, this refers to a module located at + # https://github.com/remote-name/repository-name + - name: repository-name + remote: remote-name + # This points to a west manifest file in the remote module for further imports + import: west.yml \ No newline at end of file diff --git a/zephyr/module.yml b/zephyr/module.yml new file mode 100644 index 0000000..243136a --- /dev/null +++ b/zephyr/module.yml @@ -0,0 +1,19 @@ +# Delete all unused properties. + +# Give your module a name +name: zmk-module-template +build: + # List your dependencies + depends: + - zmk-example-dependency + # Folder containing a "CMakeLists.txt" (. = root) + cmake: . + # Kconfig filepath + kconfig: Kconfig + settings: + # Folder containing a "boards" folder (. = root) + board_root: . + # Folder containing a "dts" folder (. = root) + dts_root: . + # Folder containing a "snippets" folder (. = root) + snippet_root: .