authorgravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-05-07 20:47:00 -07:00
committergravatar for hello@nektro.netMeghan Denny <hello@nektro.net> 2021-05-07 20:47:00 -07:00
log5b1f555264a3a5cc27f48d369e18ff166fd2a9b8
tree619c534c641fce45387157bfdaec5ce60eca1d3f
parentc99340270dbcbebb4706f5f7082d6d76eacc41fd

docs- add entries for `zpm search|tags|showjson`


4 files changed, 49 insertions(+), 0 deletions(-)

docs/commands/zpm.md+3
......@@ -9,3 +9,6 @@ The default remote is https://zpm.random-projects.net/.
99
1010The subcommands available are:
1111- [`add`](zpm_add.md)
12- [`search`](zpm_search.md)
13- [`tags`](zpm_tags.md)
14- [`showjson`](zpm_showjson.md)
docs/commands/zpm_search.md created+19
......@@ -0,0 +1,19 @@
1## `zpm search` command
2```
3zigmod zpm search
4```
5
6Use this subcommand to print the available packages on ZPM servers.
7
8Example output below. `......` is used to redact long output.
9
10```
11NAME AUTHOR DESCRIPTION
12sdl xq Wraps SDL2 into a nice and cozy zig-style API.
13luf Luukdegram Statically typed, embeddable, scripting language written in Zig.
14lscolors joachimschmidt557 A zig library for colorizing paths according to LS_COLORS
15......
16zig-pixman Isaac Freund zig bindings for pixman
17zalgebra Alexandre Chêne (kooparse) Linear algebra library for games and computer graphics.
18zigimg mlarouche A work in progress library to create, process, read and write different image formats
19```
docs/commands/zpm_showjson.md created+8
......@@ -0,0 +1,8 @@
1## `zpm showjson` command
2```
3zigmod zpm showjson <query>
4```
5
6This is a meta command for obtaining raw json from ZPM servers and ideally paired with [`jq`](https://stedolan.github.io/jq/).
7
8Good values for `<query>` include `"tags"` and `"packages"`.
docs/commands/zpm_tags.md created+19
......@@ -0,0 +1,19 @@
1## `zpm tags` command
2```
3zigmod zpm tags
4```
5
6Use this subcommand to print the available tags on ZPM servers.
7
8Example output below. `......` is used to redact long output.
9
10```
11NAME DESCRIPTION
12hardware Packages that deal with hardware abstraction.
13networking Packages that are related to networking applications.
14game Package that are related to game development.
15......
16functional Contains functional programming constructs.
17allocator Packages that are related to memory allocators.
18terminal Packages that assist in dealing with terminal input, output, and user interfaces.
19```