diff options
| author | 2021-11-29 17:01:36 +0100 | |
|---|---|---|
| committer | 2021-11-29 17:09:26 +0100 | |
| commit | b2059e5d086731a37f5988bfc6bfdb0848f14ece (patch) | |
| tree | c2ebf7806f383f18ebc7253bbe9e6e9da2db39d4 /example/README.md.template | |
| parent | Fix chaining typo (diff) | |
| download | zig-clap-b2059e5d086731a37f5988bfc6bfdb0848f14ece.tar.gz zig-clap-b2059e5d086731a37f5988bfc6bfdb0848f14ece.tar.xz zig-clap-b2059e5d086731a37f5988bfc6bfdb0848f14ece.zip | |
Improve help and usage examples
Instead of just calling these function, have the examples be small
programs that demonstrates how you would actually use them together with
argument parsing.
fixes #57
Diffstat (limited to 'example/README.md.template')
| -rw-r--r-- | example/README.md.template | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/example/README.md.template b/example/README.md.template index 74a2f1d..1848d03 100644 --- a/example/README.md.template +++ b/example/README.md.template | |||
| @@ -74,6 +74,7 @@ program can take. | |||
| 74 | ``` | 74 | ``` |
| 75 | 75 | ||
| 76 | ``` | 76 | ``` |
| 77 | $ zig-out/bin/help --help | ||
| 77 | -h, --help Display this help and exit. | 78 | -h, --help Display this help and exit. |
| 78 | -v, --version Output version information and exit. | 79 | -v, --version Output version information and exit. |
| 79 | ``` | 80 | ``` |
| @@ -97,6 +98,7 @@ of the help message. | |||
| 97 | ``` | 98 | ``` |
| 98 | 99 | ||
| 99 | ``` | 100 | ``` |
| 101 | $ zig-out/bin/usage --help | ||
| 100 | [-hv] [--value <N>] | 102 | [-hv] [--value <N>] |
| 101 | ``` | 103 | ``` |
| 102 | 104 | ||