summaryrefslogtreecommitdiff
path: root/example/README.md.template
diff options
context:
space:
mode:
authorGravatar Jimmi Holst Christensen2020-04-18 16:43:18 +0200
committerGravatar Jimmi Holst Christensen2020-04-18 16:43:18 +0200
commit0b1dd505dda4c2f3076cf9d074d20666cefa0e20 (patch)
tree5b24f351c47e69f1836d7a696d63a71d9081381c /example/README.md.template
parentMerge pull request #17 from joachimschmidt557/zig-master (diff)
parentBetter readme for usage (diff)
downloadzig-clap-0b1dd505dda4c2f3076cf9d074d20666cefa0e20.tar.gz
zig-clap-0b1dd505dda4c2f3076cf9d074d20666cefa0e20.tar.xz
zig-clap-0b1dd505dda4c2f3076cf9d074d20666cefa0e20.zip
Merge branch 'master' into zig-master
Diffstat (limited to 'example/README.md.template')
-rw-r--r--example/README.md.template18
1 files changed, 18 insertions, 0 deletions
diff --git a/example/README.md.template b/example/README.md.template
index 1fd90b0..2afbe86 100644
--- a/example/README.md.template
+++ b/example/README.md.template
@@ -2,6 +2,10 @@
2 2
3A simple and easy to use command line argument parser library for Zig. 3A simple and easy to use command line argument parser library for Zig.
4 4
5Looking for a version that works with `zig master`? The `zig-master` branch has
6you covered. It is maintained by people who live at head (not me) and is merged
7into master on every `zig` release.
8
5## Features 9## Features
6 10
7* Short arguments `-a` 11* Short arguments `-a`
@@ -87,3 +91,17 @@ The `helpEx` is the generic version of `help`. It can print a help message for a
87 91
88The `helpFull` is even more generic, allowing the functions that get the help and value strings 92The `helpFull` is even more generic, allowing the functions that get the help and value strings
89to return errors and take a context as a parameter. 93to return errors and take a context as a parameter.
94
95### `usage`
96
97The `usage`, `usageEx` and `usageFull` are functions for printing a small abbreviated version
98of the help message.
99
100```zig
101{}
102```
103
104```
105[-hv] [--value <N>]
106```
107