| author |  Meghan Denny <hello@nektro.net> 2021-04-09 01:53:37 -07:00 |
| committer | Meghan Denny <hello@nektro.net> 2021-04-09 01:53:37 -07:00 |
| log | 00040d2375fe39838f413f52af272ceb2b7ed851 |
| tree | aa4e2fabd9085721fcf4bd33dc655d665d03b8f6 |
| parent | 7e345a905ccc6624db13ed5b16919249f7c79152 |
| signature |  Commit is signed but in an unrecognized format. |
docs- rename `license.md` so that it gets compiled to html
4 files changed, 23 insertions(+), 23 deletions(-)
docs/commands/README.md+1-1
| ... | @@ -3,7 +3,7 @@ Listed below is all of the commands available in Zigmod. All are meant to be run | ... | @@ -3,7 +3,7 @@ Listed below is all of the commands available in Zigmod. All are meant to be run |
| 3 | 3 | ||
| 4 | - [`init`](init.md) | 4 | - [`init`](init.md) |
| 5 | - [`fetch`](fetch.md) | 5 | - [`fetch`](fetch.md) |
| 6 | - [`license`](license.md) | 6 | - [`license`](license_.md) |
| 7 | - [`sum`](sum.md) | 7 | - [`sum`](sum.md) |
| 8 | 8 | ||
| 9 | - [`zpm`](zpm.md) | 9 | - [`zpm`](zpm.md) |
docs/commands/license.md deleted-21
| ... | @@ -1,21 +0,0 @@ | ||
| 1 | ## `license` command | ||
| 2 | ``` | ||
| 3 | zigmod license | ||
| 4 | ``` | ||
| 5 | |||
| 6 | 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. | ||
| 7 | |||
| 8 | 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. | ||
| 9 | |||
| 10 | Running this command on Zigmod itself (as of this writing) produces such output: | ||
| 11 | ``` | ||
| 12 | MIT: | ||
| 13 | = https://opensource.org/licenses/MIT | ||
| 14 | - This | ||
| 15 | - v/git/github.com/yaml/libyaml/tag-0.2.5 | ||
| 16 | - v/git/github.com/nektro/zig-ansi/commit-25039ca | ||
| 17 | - v/git/github.com/ziglibs/known-folders/commit-f0f4188 | ||
| 18 | - v/git/github.com/Vexu/zuri/commit-41bcd78 | ||
| 19 | - v/git/github.com/alexnask/iguanaTLS/commit-1767e48 | ||
| 20 | - v/git/github.com/nektro/zig-licenses/commit-1a19e4b | ||
| 21 | ``` | ||
docs/commands/license_.md created+21
| ... | @@ -0,0 +1,21 @@ | ||
| 1 | ## `license` command | ||
| 2 | ``` | ||
| 3 | zigmod license | ||
| 4 | ``` | ||
| 5 | |||
| 6 | 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. | ||
| 7 | |||
| 8 | 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. | ||
| 9 | |||
| 10 | Running this command on Zigmod itself (as of this writing) produces such output: | ||
| 11 | ``` | ||
| 12 | MIT: | ||
| 13 | = https://opensource.org/licenses/MIT | ||
| 14 | - This | ||
| 15 | - v/git/github.com/yaml/libyaml/tag-0.2.5 | ||
| 16 | - v/git/github.com/nektro/zig-ansi/commit-25039ca | ||
| 17 | - v/git/github.com/ziglibs/known-folders/commit-f0f4188 | ||
| 18 | - v/git/github.com/Vexu/zuri/commit-41bcd78 | ||
| 19 | - v/git/github.com/alexnask/iguanaTLS/commit-1767e48 | ||
| 20 | - v/git/github.com/nektro/zig-licenses/commit-1a19e4b | ||
| 21 | ``` | ||
docs/zig.mod.md+1-1
| ... | @@ -16,7 +16,7 @@ The is the local path to the entry point of your package and the file that will | ... | @@ -16,7 +16,7 @@ The is the local path to the entry point of your package and the file that will |
| 16 | 16 | ||
| 17 | ### `license` | 17 | ### `license` |
| 18 | - Type: `string` | 18 | - Type: `string` |
| 19 | 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. | 19 | 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. |
| 20 | 20 | ||
| 21 | ### `c_include_dirs` | 21 | ### `c_include_dirs` |
| 22 | - Type: `[]string` | 22 | - Type: `[]string` |