diff options
| author | Pascal Getreuer | 2025-04-01 07:06:42 +0200 |
|---|---|---|
| committer | GitHub | 2025-04-01 07:06:42 +0200 |
| commit | da166d4d8b1eb5cf984a08effdf20faaca2b3234 (patch) | |
| tree | 07d4bac5c1f532ff5d7432c5f3fd74f924e0dfbe /docs | |
| parent | 3cd292498566cd94983a5311156fb3b7f348d911 (diff) | |
Add "license" field to Community Module JSON schema. (#25085)
Add "license" field to community module schema.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/features/community_modules.md | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/features/community_modules.md b/docs/features/community_modules.md index a28c5afaeb..52526c9fe8 100644 --- a/docs/features/community_modules.md +++ b/docs/features/community_modules.md @@ -72,6 +72,7 @@ A Community Module is denoted by a `qmk_module.json` file such as the following: { "module_name": "Hello World", "maintainer": "QMK Maintainers", + "license": "GPL-2.0-or-later", "features": { "deferred_exec": true }, @@ -86,6 +87,10 @@ A Community Module is denoted by a `qmk_module.json` file such as the following: At minimum, the module must provide the `module_name` and `maintainer` fields. +The `license` field is encouraged to indicate the terms for using and sharing the module. It is recommended to use a [SPDX license identifier](https://spdx.org/licenses/) like "`Apache-2.0`" or "`GPL-2.0-or-later`" if possible. + +The `url` field may specify a URL to more information about the module. + The use of `features` matches the definition normally provided within `keyboard.json` and `info.json`, allowing a module to signal to the build system that it has its own dependencies. In the example above, it enables the _deferred executor_ feature whenever the above module is used in a build. The `keycodes` array allows a module to provide new keycodes (as well as corresponding aliases) to a keymap. |