External/cxxopts
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Jarryd Beck 2016-01-28 07:26:10 +11:00
parent 5a7585026d
commit aec97a6f53
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -24,7 +24,7 @@ Create a cxxopts::Options instance.
cxxopts::Options options; cxxopts::Options options;
Then use add_options. Then use `add_options`.
options.add_options() options.add_options()
("d,debug", "Enable debugging") ("d,debug", "Enable debugging")
@ -46,13 +46,22 @@ it appeared, and
to get its value. If "opt" doesn't exist, or isn't of the right type, then an to get its value. If "opt" doesn't exist, or isn't of the right type, then an
exception will be thrown. exception will be thrown.
## Help groups
Options can be placed into groups for the purposes of displaying help messages.
To place options in a group, pass the group as a string to `add_options`. Then,
when displaying the help, pass the groups that you would like displayed as a
vector to the `help` function.
## Positional Arguments ## Positional Arguments
Positional arguments can be optionally parsed into one or more options. To set up positional arguments, call Positional arguments can be optionally parsed into one or more options.
To set up positional arguments, call
options.parse_positional({"first", "second", "last"}) options.parse_positional({"first", "second", "last"})
where "last" should be the name of an option with a container type, and the others should have a single value. where "last" should be the name of an option with a container type, and the
others should have a single value.
# Linking # Linking