clap/examples/README.md

# Examples

- Basic demo: [derive](demo.md)
- Key-value pair arguments: [derive](keyvalue_derive.md)
- git-like interface: [builder](git.md), [derive](git_derive.md)
- pacman-like interface: [builder](git.md)
- Escaped positionals with `--`: [builder](escaped_positional.md), [derive](escaped_positional_derive.md)
- Multi-call
  - busybox: [builder](multicall_busybox.md)
  - hostname: [builder](multicall_hostname.md)

## Contributing

New examples:
- Building: They must be added to [Cargo.toml](../../Cargo.toml) with the appropriate `required-features`.
- Testing: Ensure there is a markdown file with [trycmd](https://docs.rs/trycmd) syntax
- Link the `.md` file from here

See also the general [CONTRIBUTING](../../CONTRIBUTING.md).
docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`# Examples`
test: More thoroughly test examples This ports our example testing over to [trycmd](https://docs.rs/) so we can: - More thoroughly test our examples - Provide always-up-to-date example usage The old way of testing automatically picked up examples. This new way requires we have a `.md` file that uses the example in some way. Notes: - Moved overall example description to the `.md` file - I added cross-linking between related examples - `14_groups` had a redundant paragraph (twice talked about "one and only one" 2021-11-10 22:15:30 +00:00
docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`- Basic demo: [derive](demo.md)`
docs: Add key-value derive example This is carried over from the clap_derive examples. Looking over the other examples, I feel like they are covered by other examples or by the derive reference. We should call out deny missing docs though. 2021-12-08 01:01:55 +00:00			`- Key-value pair arguments: [derive](keyvalue_derive.md)`
docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`- git-like interface: [builder](git.md), [derive](git_derive.md)`
			`- pacman-like interface: [builder](git.md)`
			- Escaped positionals with `--`: [builder](escaped_positional.md), [derive](escaped_positional_derive.md)
			`- Multi-call`
			`- busybox: [builder](multicall_busybox.md)`
			`- hostname: [builder](multicall_hostname.md)`
test: More thoroughly test examples This ports our example testing over to [trycmd](https://docs.rs/) so we can: - More thoroughly test our examples - Provide always-up-to-date example usage The old way of testing automatically picked up examples. This new way requires we have a `.md` file that uses the example in some way. Notes: - Moved overall example description to the `.md` file - I added cross-linking between related examples - `14_groups` had a redundant paragraph (twice talked about "one and only one" 2021-11-10 22:15:30 +00:00
			`## Contributing`

docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`New examples:`
			- Building: They must be added to [Cargo.toml](../../Cargo.toml) with the appropriate `required-features`.
			`- Testing: Ensure there is a markdown file with [trycmd](https://docs.rs/trycmd) syntax`
			- Link the `.md` file from here

			`See also the general [CONTRIBUTING](../../CONTRIBUTING.md).`