summaryrefslogtreecommitdiff
path: root/example/README.md.template
diff options
context:
space:
mode:
authorGravatar Jimmi Holst Christensen2022-03-30 16:28:16 +0200
committerGravatar Komari Spaghetti2022-03-30 21:57:51 +0200
commit984c22948b70bd1cbfef9f2d514d42e27541c1f1 (patch)
tree3693976dccd1fa8c9ff5d722aba4d306a10c9fdf /example/README.md.template
parentFix long param parsing with '-' and '\_' in name (diff)
downloadzig-clap-984c22948b70bd1cbfef9f2d514d42e27541c1f1.tar.gz
zig-clap-984c22948b70bd1cbfef9f2d514d42e27541c1f1.tar.xz
zig-clap-984c22948b70bd1cbfef9f2d514d42e27541c1f1.zip
New `help` api that provides options as to how paramters are printed.
fixes \#28
Diffstat (limited to 'example/README.md.template')
-rw-r--r--example/README.md.template10
1 files changed, 7 insertions, 3 deletions
diff --git a/example/README.md.template b/example/README.md.template
index b76ae45..8b12cd6 100644
--- a/example/README.md.template
+++ b/example/README.md.template
@@ -58,7 +58,8 @@ is generated at runtime.
58 58
59The `help` prints a simple list of all parameters the program can take. It expects the 59The `help` prints a simple list of all parameters the program can take. It expects the
60`Id` to have a `description` method and an `value` method so that it can provide that 60`Id` to have a `description` method and an `value` method so that it can provide that
61in the output. 61in the output. `HelpOptions` is passed to `help` to control how the help message is
62printed.
62 63
63```zig 64```zig
64{s} 65{s}
@@ -66,8 +67,11 @@ in the output.
66 67
67``` 68```
68$ zig-out/bin/help --help 69$ zig-out/bin/help --help
69 -h, --help Display this help and exit. 70 -h, --help
70 -v, --version Output version information and exit. 71 Display this help and exit.
72
73 -v, --version
74 Output version information and exit.
71``` 75```
72 76
73### `usage` 77### `usage`