1 files changed, 0 insertions, 129 deletions
diff --git a/example/README.md.template b/example/README.md.template
deleted file mode 100644
index 4fe1d87..0000000
--- a/example/README.md.template
+++ /dev/null
@@ -1,129 +0,0 @@
-<!---
-README.md is autogenerated. Please edit example/README.md.template instead.
-->
-# zig-clap
-A simple and easy to use command line argument parser library for Zig.
-## Installation
-Developers tend to either use
-* The latest tagged release of Zig
-* The latest build of Zigs master branch
-Depending on which developer you are, you need to run different `zig fetch` commands:
-```sh
-# Version of zig-clap that works with a tagged release of Zig
-# Replace `<REPLACE ME>` with the version of zig-clap that you want to use
-# See: https://github.com/Hejsil/zig-clap/releases
-zig fetch --save https://github.com/Hejsil/zig-clap/archive/refs/tags/<REPLACE ME>.tar.gz
-# Version of zig-clap that works with latest build of Zigs master branch
-zig fetch --save git+https://github.com/Hejsil/zig-clap
-```
-Then add the following to `build.zig`:
-```zig
-const clap = b.dependency("clap", .{{}});
-exe.root_module.addImport("clap", clap.module("clap"));
-```
-## Features
-* Short arguments `-a`
-  * Chaining `-abc` where `a` and `b` does not take values.
-  * Multiple specifications are tallied (e.g. `-v -v`).
-* Long arguments `--long`
-* Supports both passing values using spacing and `=` (`-a 100`, `-a=100`)
-  * Short args also support passing values with no spacing or `=` (`-a100`)
-  * This all works with chaining (`-ba 100`, `-ba=100`, `-ba100`)
-* Supports options that can be specified multiple times (`-e 1 -e 2 -e 3`)
-* Print help message from parameter specification.
-* Parse help message to parameter specification.
-## API Reference
-Automatically generated API Reference for the project can be found at
-https://Hejsil.github.io/zig-clap. Note that Zig autodoc is in beta; the website
-may be broken or incomplete.
-## Examples
-### `clap.parse`
-The simplest way to use this library is to just call the `clap.parse` function.
-```zig
-{s}
-```
-The result will contain an `args` field and a `positionals` field. `args` will have one field for
-each non-positional parameter of your program. The name of the field will be the longest name of the
-parameter. `positionals` will be a tuple with one field for each positional parameter.
-The fields in `args` and `postionals` are typed. The type is based on the name of the value the
-parameter takes. Since `--number` takes a `usize` the field `res.args.number` has the type `usize`.
-Note that this is only the case because `clap.parsers.default` has a field called `usize` which
-contains a parser that returns `usize`. You can pass in something other than `clap.parsers.default`
-if you want some other mapping.
-```zig
-{s}
-```
-### Subcommands
-There is an option for `clap.parse` and `clap.parseEx` called `terminating_positional`. It allows
-for users of `clap` to implement subcommands in their cli application:
-```zig
-{s}
-```
-### `streaming.Clap`
-The `streaming.Clap` is the base of all the other parsers. It's a streaming parser that uses an
-`args.Iterator` to provide it with arguments lazily.
-```zig
-{s}
-```
-Currently, this parser is the only parser that allows an array of `Param` that is generated at runtime.
-### `help`
-`help` prints a simple list of all parameters the program can take. It expects the `Id` to have a
-`description` method and an `value` method so that it can provide that in the output. `HelpOptions`
-is passed to `help` to control how the help message is printed.
-```zig
-{s}
-```
-```
-$ zig-out/bin/help --help
-    -h, --help
-            Display this help and exit.
-    -v, --version
-            Output version information and exit.
-```
-### `usage`
-`usage` prints a small abbreviated version of the help message. It expects the `Id` to have a
-`value` method so it can provide that in the output.
-```zig
-{s}
-```
-```
-$ zig-out/bin/usage --help
-[-hv] [--value <str>]
-```

diff --git a/example/README.md.template b/example/README.md.template deleted file mode 100644 index 4fe1d87..0000000 --- a/example/README.md.template +++ /dev/null
@@ -1,129 +0,0 @@
1	<!---
2	README.md is autogenerated. Please edit example/README.md.template instead.
3	-->
4	# zig-clap
5
6	A simple and easy to use command line argument parser library for Zig.
7
8	## Installation
9
10	Developers tend to either use
11	* The latest tagged release of Zig
12	* The latest build of Zigs master branch
13
14	Depending on which developer you are, you need to run different `zig fetch` commands:
15
16	```sh
17	# Version of zig-clap that works with a tagged release of Zig
18	# Replace `<REPLACE ME>` with the version of zig-clap that you want to use
19	# See: https://github.com/Hejsil/zig-clap/releases
20	zig fetch --save https://github.com/Hejsil/zig-clap/archive/refs/tags/<REPLACE ME>.tar.gz
21
22	# Version of zig-clap that works with latest build of Zigs master branch
23	zig fetch --save git+https://github.com/Hejsil/zig-clap
24	```
25
26	Then add the following to `build.zig`:
27
28	```zig
29	const clap = b.dependency("clap", .{{}});
30	exe.root_module.addImport("clap", clap.module("clap"));
31	```
32
33	## Features
34
35	* Short arguments `-a`
36	* Chaining `-abc` where `a` and `b` does not take values.
37	* Multiple specifications are tallied (e.g. `-v -v`).
38	* Long arguments `--long`
39	* Supports both passing values using spacing and `=` (`-a 100`, `-a=100`)
40	* Short args also support passing values with no spacing or `=` (`-a100`)
41	* This all works with chaining (`-ba 100`, `-ba=100`, `-ba100`)
42	* Supports options that can be specified multiple times (`-e 1 -e 2 -e 3`)
43	* Print help message from parameter specification.
44	* Parse help message to parameter specification.
45
46	## API Reference
47
48	Automatically generated API Reference for the project can be found at
49	https://Hejsil.github.io/zig-clap. Note that Zig autodoc is in beta; the website
50	may be broken or incomplete.
51
52	## Examples
53
54	### `clap.parse`
55
56	The simplest way to use this library is to just call the `clap.parse` function.
57
58	```zig
59	{s}
60	```
61
62	The result will contain an `args` field and a `positionals` field. `args` will have one field for
63	each non-positional parameter of your program. The name of the field will be the longest name of the
64	parameter. `positionals` will be a tuple with one field for each positional parameter.
65
66	The fields in `args` and `postionals` are typed. The type is based on the name of the value the
67	parameter takes. Since `--number` takes a `usize` the field `res.args.number` has the type `usize`.
68
69	Note that this is only the case because `clap.parsers.default` has a field called `usize` which
70	contains a parser that returns `usize`. You can pass in something other than `clap.parsers.default`
71	if you want some other mapping.
72
73	```zig
74	{s}
75	```
76
77	### Subcommands
78
79	There is an option for `clap.parse` and `clap.parseEx` called `terminating_positional`. It allows
80	for users of `clap` to implement subcommands in their cli application:
81
82	```zig
83	{s}
84	```
85
86	### `streaming.Clap`
87
88	The `streaming.Clap` is the base of all the other parsers. It's a streaming parser that uses an
89	`args.Iterator` to provide it with arguments lazily.
90
91	```zig
92	{s}
93	```
94
95	Currently, this parser is the only parser that allows an array of `Param` that is generated at runtime.
96
97	### `help`
98
99	`help` prints a simple list of all parameters the program can take. It expects the `Id` to have a
100	`description` method and an `value` method so that it can provide that in the output. `HelpOptions`
101	is passed to `help` to control how the help message is printed.
102
103	```zig
104	{s}
105	```
106
107	```
108	$ zig-out/bin/help --help
109	-h, --help
110	Display this help and exit.
111
112	-v, --version
113	Output version information and exit.
114	```
115
116	### `usage`
117
118	`usage` prints a small abbreviated version of the help message. It expects the `Id` to have a
119	`value` method so it can provide that in the output.
120
121	```zig
122	{s}
123	```
124
125	```
126	$ zig-out/bin/usage --help
127	[-hv] [--value <str>]
128	```
129