diff options
Diffstat (limited to 'example/README.md.template')
| -rw-r--r-- | example/README.md.template | 18 |
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 | ||
| 3 | A simple and easy to use command line argument parser library for Zig. | 3 | A simple and easy to use command line argument parser library for Zig. |
| 4 | 4 | ||
| 5 | Looking for a version that works with `zig master`? The `zig-master` branch has | ||
| 6 | you covered. It is maintained by people who live at head (not me) and is merged | ||
| 7 | into 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 | ||
| 88 | The `helpFull` is even more generic, allowing the functions that get the help and value strings | 92 | The `helpFull` is even more generic, allowing the functions that get the help and value strings |
| 89 | to return errors and take a context as a parameter. | 93 | to return errors and take a context as a parameter. |
| 94 | |||
| 95 | ### `usage` | ||
| 96 | |||
| 97 | The `usage`, `usageEx` and `usageFull` are functions for printing a small abbreviated version | ||
| 98 | of the help message. | ||
| 99 | |||
| 100 | ```zig | ||
| 101 | {} | ||
| 102 | ``` | ||
| 103 | |||
| 104 | ``` | ||
| 105 | [-hv] [--value <N>] | ||
| 106 | ``` | ||
| 107 | |||