João Marcos
24760bc261
style: replacing yml with yaml for consistency
2020-07-20 20:58:34 -03:00
Ronald Leppink
036ba49ccf
docs: switch debug and verbosity args in macro example
...
The other examples have `verbosity` as a default arg, and `debug` as a `test` subcommand arg. The macro example has these two switched up -- this corrects that.
2020-06-28 14:34:48 +02:00
Gabriel Lima
0512e7cea6
docs(README.md): Fixes typo at line 413
...
Fixes issue #1984
2020-06-25 10:01:52 -03:00
Gonçalo Ribeiro
fb8e0d815d
docs: correct some typos
2020-05-30 11:14:47 +01:00
Pavan Kumar Sunkara
7bc282dd4e
Rename with_name to new for Arg & ArgGroup
2020-05-14 22:50:56 +02:00
Pavan Kumar Sunkara
954dd3e20a
Test readme too
2020-05-02 22:27:45 +02:00
Pavan Kumar Sunkara
a67d1d7a40
Update README for beta release
2020-05-02 22:27:42 +02:00
Noritada Kobayashi
6d62cca1ac
docs(README.md): fix a broken link to CONTRIBUTING.md
2020-05-03 03:56:35 +09:00
dbxnr
8769dfa972
Fix link to 13_enum_values example
2020-05-01 21:32:43 +01:00
Richard Hozák
a3603f20fe
Fix README link
...
Fixes link pointing to archived version of `clap_generate`.
2020-04-17 22:30:40 +02:00
Ivan Tham
54f58e180e
Remove extern crate from README
2020-04-08 21:26:32 +08:00
Stephan Boyer
606d120d18
Update the documentation regarding which features are enabled by default
2020-04-04 13:16:30 -07:00
Pavan Kumar Sunkara
b77f159315
Moved to github discussions
2020-04-01 22:32:51 +02:00
CreepySkeleton
16ffaea58d
Advertise gitter chat
2020-03-27 18:00:47 +03:00
Justin Walz
dd14f0da74
Update README.md
2020-03-21 17:24:34 -07:00
Akshat Agarwal
848ebb4e44
gitter fix
2020-03-22 02:11:51 +05:30
Kevin K
2b017f5450
docs(README.md): adds details about MSRV by clap version
2020-03-04 22:06:06 -05:00
CreepySkeleton
11f04e229a
Update README.md
2020-02-10 22:16:34 +03:00
CreepySkeleton
a45b116795
Add "work in progress" disclaimer to readme
...
Closes #1684
2020-02-10 14:47:11 +03:00
Alex van de Sandt
81b8bdd7fc
Remove #[macro_use] from examples
2020-02-03 12:01:36 -05:00
Pavan Kumar Sunkara
6c338e42d0
Faster CI
2020-02-03 03:57:52 +01:00
Eric Mink
1c3958c56e
Clarify documentation usage as help text for subcommands ( #1620 )
...
* Clarify documentation usage as help text for subcommands
As outlined in https://github.com/clap-rs/clap/issues/1619 I did not understand why the `SUBCOMMANDS` section of `help` would not print a String `/// A subcommand for controlling testing` for the `Test` subcommand.
This PR updates the README to hopefully make this clearer.
The only change is adding a doc line:
```rust
#[derive(Clap)]
enum SubCommand {
/// A help message for the Test subcommand
Test(Test),
}
```
* Move annotation to the variant
Still regarding https://github.com/clap-rs/clap/issues/1619
I think the line that set the version of the subcommand was at the wrong place.
2020-01-04 19:54:33 +05:30
Matthew Fisher
bb9631eb3f
fix(README): fix compiler errors for first example ( #1599 )
...
The first example doesn't compile. The Test structure is missing a `struct` statement, and the `.config` field exists as `.file`. Looking at the flag fields, `config` seems like the expected field name.
Using
```
[dependencies]
clap = { git = "https://github.com/clap-rs/clap ", features = ["wrap_help"] }
```
Signed-Off-By: Matthew Fisher <matt.fisher@microsoft.com>
2019-11-30 00:35:26 +01:00
Kevin K
9d58bbee24
docs(README.md): fixes the custom derive example in the readme
...
Closes #1589
2019-10-30 20:30:29 -04:00
Kevin K
7f046f28ab
Merge pull request #1590 from clap-rs/msrv-1.36
...
Msrv 1.36
2019-10-30 18:30:44 -04:00
Kevin K
98e8cfe0c4
meta: Bump the minimum supported Rust to 1.36
2019-10-30 16:56:27 -04:00
Dylan DPC
5318342112
Update README.md
2019-10-30 10:28:37 +01:00
Kevin K
4fdca7b4e6
docs: corrects notes about v2 vs v3 branches
2019-10-29 22:30:17 -04:00
Kevin K
1cc872b369
Rename assert_cli to assert_cmd
2019-10-29 22:25:22 -04:00
Dylan DPC
655f4262dd
Add note for 3.0 release ( #1503 )
2019-10-29 22:24:52 -04:00
Daniel José Domingos Serrano
59c3233a45
Fix yaml docs
2019-10-29 21:49:00 -04:00
Sascha Grunert
b6ebdba2e1
Fix opts variable name in README.md
2019-10-29 21:45:47 -04:00
Yuki Okushi
e56b80b316
Fix license badge on README
2019-10-29 21:44:20 -04:00
Tshepang Lekhonkhobe
a720de3f24
typo
2019-10-29 21:44:01 -04:00
Erick Tryzelaar
d4cd4896dd
Bump minimum supported version of Rust to 1.33
2019-06-19 11:21:11 -07:00
Kevin K
3f2a85ef15
Fix Travis CI badge
2019-04-04 13:24:24 -04:00
Kevin K
3550066c88
refactor: cleans out deprecated code in prep for final beta.1 push
2018-11-08 20:34:13 -05:00
Kevin K
03333800fe
refactor: remove code going to other crates and deprecations
2018-10-19 23:31:06 -04:00
Kevin K
1ffc9556b7
docs(README.md): stars the v3 update of the docs
2018-08-01 23:05:52 -04:00
Kevin K
94872e00a5
refactor(Arg): changes Arg::short to accept a char instead of &str
...
Closes #1303
2018-07-23 15:10:12 -04:00
Kevin K
ab8c97e3f1
chore: relicense under MIT and APACHE 2.0
2018-07-23 14:25:18 -04:00
Dylan DPC
6a99e638f7
Fix assert_cli url
...
Even though github redirects to the correct url, it is better to mention the correct one 😄
2018-06-30 19:33:58 -04:00
Simon Egersand
30e6cd192a
Fix formatting in README
2018-06-30 19:33:43 -04:00
Katharina
919fd32dfb
Moving the line into the apropriate section
2018-03-19 17:11:57 -04:00
Kevin K
e1d1c06d45
chore: updates version sync in readme
2018-02-09 23:40:55 -05:00
Kevin K
300a059f51
chore: updates the version tests
2018-02-03 15:22:56 -05:00
Kevin K
df996822c8
chore: increase version
2018-01-16 15:01:53 -05:00
Kevin K
3fef176543
docs: fixes typo in docs version
2018-01-09 12:07:19 -05:00
Kevin K
92caafaf51
chore: increase version
2018-01-09 11:08:47 -05:00
Romain Vimont
d954b3c734
Update default features in README
...
Since commit ac97edde90
2017-12-05 13:55:57 +01:00
