Commit 9c700eca3e151376b7df8f51b4e1133c2fcae2e3
Committed by
Henry Schreiner
1 parent
cd8b8d9b
Adding changelog and readme mention
Showing
2 changed files
with
20 additions
and
0 deletions
CHANGELOG.md
| 1 | 1 | ## In progress |
| 2 | 2 | |
| 3 | +This version has some internal cleanup and improved support for the newest compilers. | |
| 4 | + | |
| 5 | +Note: This is the final release with `requires`, please switch to `needs`. | |
| 6 | + | |
| 3 | 7 | * Fix unlimited short options eating two values before checking for positionals when no space present [#90] |
| 4 | 8 | * Symmetric exclude text when excluding options, exclude can be called multiple times [#64] |
| 9 | +* Support for `std::optional`, `std::experimental::optional`, and `boost::optional` added if `__has_include` is supported [#95] | |
| 10 | +* All macros/CMake variables now start with `CLI11_` instead of just `CLI_` [#95] | |
| 11 | +* The internal stream was not being cleared before use in some cases. Fixed. [#95] | |
| 12 | + | |
| 13 | +Other, non-user facing changes: | |
| 14 | + | |
| 15 | +* Added `Macros.hpp` with better C++ mode discovery [#95] | |
| 16 | +* Deprecated macros added for all platforms | |
| 17 | +* C++17 is now tested on supported platforms [#95] | |
| 18 | +* Informational printout now added to CTest [#95] | |
| 19 | +* Better single file generation [#95] | |
| 20 | +* Added support for GTest on MSVC 2017 (but not in C++17 mode, will need next version of GTest) | |
| 5 | 21 | |
| 6 | 22 | [#64]: https://github.com/CLIUtils/CLI11/issues/64 |
| 7 | 23 | [#90]: https://github.com/CLIUtils/CLI11/issues/90 |
| 24 | +[#95]: https://github.com/CLIUtils/CLI11/pull/95 | |
| 8 | 25 | |
| 9 | 26 | |
| 10 | 27 | ## Version 1.4: More feedback | ... | ... |
README.md
| ... | ... | @@ -164,6 +164,8 @@ An option name must start with a alphabetic character or underscore. For long op |
| 164 | 164 | |
| 165 | 165 | On a C++14 compiler, you can pass a callback function directly to `.add_flag`, while in C++11 mode you'll need to use `.add_flag_function` if you want a callback function. The function will be given the number of times the flag was passed. You can throw a relevant `CLI::ParseError` to signal a failure. |
| 166 | 166 | |
| 167 | +On a compiler that supports C++17's `__has_include`, you can also use `std::optional`, `std::experimental::optional`, and `boost::optional` directly in an `add_option` call. See [CLI11 Internals] for information on how this was done and how you can add your own converters. | |
| 168 | + | |
| 167 | 169 | ### Example |
| 168 | 170 | |
| 169 | 171 | * `"one,-o,--one"`: Valid as long as not a flag, would create an option that can be specified positionally, or with `-o` or `--one` |
| ... | ... | @@ -421,6 +423,7 @@ CLI11 was developed at the [University of Cincinnati] to support of the [GooFit] |
| 421 | 423 | [NSF Award 1414736]: https://nsf.gov/awardsearch/showAward?AWD_ID=1414736 |
| 422 | 424 | [University of Cincinnati]: http://www.uc.edu |
| 423 | 425 | [GitBook]: https://cliutils.gitlab.io/CLI11Tutorial |
| 426 | +[CLI11 Internals]: https://cliutils.gitlab.io/CLI11Tutorial/chapters/internals.html | |
| 424 | 427 | [ProgramOptions.hxx]: https://github.com/Fytch/ProgramOptions.hxx |
| 425 | 428 | [Argument Aggregator]: https://github.com/vietjtnguyen/argagg |
| 426 | 429 | [Args]: https://github.com/Taywee/args | ... | ... |