Commit 1be5f10daf6f08296eff399e82aa94d16800ef4e
1 parent
e005d076
clarify wording on short/long
Fixes #37. A long option is required, a short option is not.
Showing
1 changed file
with
3 additions
and
3 deletions
README.md
| ... | ... | @@ -33,9 +33,9 @@ Then use `add_options`. |
| 33 | 33 | ("f,file", "File name", cxxopts::value<std::string>()) |
| 34 | 34 | ; |
| 35 | 35 | |
| 36 | -Options can be declared with a short and/or long option. A description must be | |
| 37 | -provided. The third argument is the value, if omitted it is boolean. Any type | |
| 38 | -can be given as long as it can be parsed, with operator>>. | |
| 36 | +Options are declared with a long and an optional short option. A description | |
| 37 | +must be provided. The third argument is the value, if omitted it is boolean. | |
| 38 | +Any type can be given as long as it can be parsed, with operator>>. | |
| 39 | 39 | |
| 40 | 40 | To parse the command line do: |
| 41 | 41 | ... | ... |