Peter M. Groen / cxxopts

Commit 3f5bbb306242cee407b6793fadfbe938d8f0c8f6

Authored by Jarryd Beck
1 parent ef1dfdee

update the readme

Inline Side-by-side
Showing 1 changed file with 3 additions and 5 deletions
README.md
  View file @3f5bbb3
@@ -39,12 +39,12 @@ Any type can be given as long as it can be parsed, with operator>>. @@ -39,12 +39,12 @@ Any type can be given as long as it can be parsed, with operator>>.
39 39
40 To parse the command line do: 40 To parse the command line do:
41 41
42 - options.parse(argc, argv); 42 + auto result = options.parse(argc, argv);
43 43
44 -To retrieve an option use `options.count("option")` to get the number of times 44 +To retrieve an option use `result.count("option")` to get the number of times
45 it appeared, and 45 it appeared, and
46 46
47 - options["opt"].as<type>() 47 + result["opt"].as<type>()
48 48
49 to get its value. If "opt" doesn't exist, or isn't of the right type, then an 49 to get its value. If "opt" doesn't exist, or isn't of the right type, then an
50 exception will be thrown. 50 exception will be thrown.
@@ -93,9 +93,7 @@ This is a header only library. @@ -93,9 +93,7 @@ This is a header only library.
93 The only build requirement is a C++ compiler that supports C++11 regular 93 The only build requirement is a C++ compiler that supports C++11 regular
94 expressions. For example GCC >= 4.9 or clang with libc++. 94 expressions. For example GCC >= 4.9 or clang with libc++.
95 95
96 -  
97 # TODO list 96 # TODO list
98 97
99 * Allow unrecognised options. 98 * Allow unrecognised options.
100 * Various help strings. 99 * Various help strings.
101 -* Unicode aware for help strings.