diff --git a/docs/commands/README.md b/docs/commands/README.md index e9435fcd96144204e7c75351b61241dccf97e288..e5aacdeee4fd6cf744a036a8b0fa584dfecbe205 100644 --- a/docs/commands/README.md +++ b/docs/commands/README.md @@ -3,7 +3,7 @@ Listed below is all of the commands available in Zigmod. All are meant to be run - [`init`](init.md) - [`fetch`](fetch.md) -- [`license`](license.md) +- [`license`](license_.md) - [`sum`](sum.md) - [`zpm`](zpm.md) diff --git a/docs/commands/license.md b/docs/commands/license.md deleted file mode 100644 index bb1627367b1ba3d50f005181564f4652c51475fa..0000000000000000000000000000000000000000 --- a/docs/commands/license.md +++ /dev/null @@ -1,21 +0,0 @@ -## `license` command -``` -zigmod license -``` - -This will print a listing of all of your dependencies (deeply)' licenses. Any code is valid for the `license` field in `zig.mod` but should it match a valid SPDX identifier, a URL to learn more about the license will also be printed so the user can learn more about it. - -Should one of your dependencies not have a `license` field in their `zig.mod` manifest, an `Unspecified:` list will appear at the bottom of the output. - -Running this command on Zigmod itself (as of this writing) produces such output: -``` -MIT: -= https://opensource.org/licenses/MIT -- This -- v/git/github.com/yaml/libyaml/tag-0.2.5 -- v/git/github.com/nektro/zig-ansi/commit-25039ca -- v/git/github.com/ziglibs/known-folders/commit-f0f4188 -- v/git/github.com/Vexu/zuri/commit-41bcd78 -- v/git/github.com/alexnask/iguanaTLS/commit-1767e48 -- v/git/github.com/nektro/zig-licenses/commit-1a19e4b -``` diff --git a/docs/commands/license_.md b/docs/commands/license_.md new file mode 100644 index 0000000000000000000000000000000000000000..bb1627367b1ba3d50f005181564f4652c51475fa --- /dev/null +++ b/docs/commands/license_.md @@ -0,0 +1,21 @@ +## `license` command +``` +zigmod license +``` + +This will print a listing of all of your dependencies (deeply)' licenses. Any code is valid for the `license` field in `zig.mod` but should it match a valid SPDX identifier, a URL to learn more about the license will also be printed so the user can learn more about it. + +Should one of your dependencies not have a `license` field in their `zig.mod` manifest, an `Unspecified:` list will appear at the bottom of the output. + +Running this command on Zigmod itself (as of this writing) produces such output: +``` +MIT: += https://opensource.org/licenses/MIT +- This +- v/git/github.com/yaml/libyaml/tag-0.2.5 +- v/git/github.com/nektro/zig-ansi/commit-25039ca +- v/git/github.com/ziglibs/known-folders/commit-f0f4188 +- v/git/github.com/Vexu/zuri/commit-41bcd78 +- v/git/github.com/alexnask/iguanaTLS/commit-1767e48 +- v/git/github.com/nektro/zig-licenses/commit-1a19e4b +``` diff --git a/docs/zig.mod.md b/docs/zig.mod.md index ccf4a1edd1dbeecd2da8a7194b4fdc7cb40ab763..2d78b7060696f249e642166618845655903128cd 100644 --- a/docs/zig.mod.md +++ b/docs/zig.mod.md @@ -16,7 +16,7 @@ The is the local path to the entry point of your package and the file that will ### `license` - Type: `string` -This is an optional field that may be set to specify the license that your package code is covered by. This field is read by the [`zigmod license`](commands/license.md) command to show the licenses used by all of a project's dependencies. If the value of `license` is set to a [SPDX Identifier](https://spdx.org/licenses/) then a link to the license will also be printed for the user to learn more about it. Check the command reference for more info. +This is an optional field that may be set to specify the license that your package code is covered by. This field is read by the [`zigmod license`](commands/license_.md) command to show the licenses used by all of a project's dependencies. If the value of `license` is set to a [SPDX Identifier](https://spdx.org/licenses/) then a link to the license will also be printed for the user to learn more about it. Check the command reference for more info. ### `c_include_dirs` - Type: `[]string`