From 97f5460fbe1e2e436161b24f8549fa82c56b57be Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Sun, 4 Apr 2021 01:58:15 -0400 Subject: [PATCH] docs: update changelog (#564) --- CHANGELOG.md | 36 ++++++++++++++++++++++++++++++++---- README.md | 4 ++-- 2 files changed, 34 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index f9cc853b..d2a59b47 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,14 +1,42 @@ ## Version 2.0: In progress -* Built-in config format is TOML compliant now [#435] -* Config updates [#442] -* More powerful containers, `%%` separator [#423] -* Add a version flag easily [#452] +* Built-in config format is TOML compliant now [#435][] + * Support multiline TOML [#528][] +* Support short/positional options in config mode [#443][] +* More powerful containers, `%%` separator [#423][] +* Add a version flag easily [#452][] +* Support atomic types [#520][] +* Add a type validator `CLI::TypeValidator` [#526][] +* Support `->silent()` on subcommands. [#529][] +* Add alias section to help for subcommands [#545][] +* Redesigned MakeSingleFiles to have a higher level of manual control, to support future features. [#546][] +* Moved testing from GTest to Catch2 [#574][] + +* Bugfix: avoid listing helpall as a required flag [#530][] +* Bugfix: avoid a clash with WINDOWS define [#563][] + +* Removed deprecated set commands, use validators instead. [#565][] + +* Build: support pkg-config [#523][] + [#435]: https://github.com/CLIUtils/CLI11/pull/435 [#443]: https://github.com/CLIUtils/CLI11/pull/443 [#423]: https://github.com/CLIUtils/CLI11/pull/423 [#452]: https://github.com/CLIUtils/CLI11/pull/452 +[#520]: https://github.com/CLIUtils/CLI11/pull/520 +[#523]: https://github.com/CLIUtils/CLI11/pull/523 +[#526]: https://github.com/CLIUtils/CLI11/pull/526 +[#528]: https://github.com/CLIUtils/CLI11/pull/528 +[#529]: https://github.com/CLIUtils/CLI11/pull/529 +[#530]: https://github.com/CLIUtils/CLI11/pull/530 +[#545]: https://github.com/CLIUtils/CLI11/pull/545 +[#546]: https://github.com/CLIUtils/CLI11/pull/546 +[#563]: https://github.com/CLIUtils/CLI11/pull/563 +[#565]: https://github.com/CLIUtils/CLI11/pull/565 +[#574]: https://github.com/CLIUtils/CLI11/pull/574 + + ### Version 1.9.1: Backporting fixes diff --git a/README.md b/README.md index 8ffb6b25..846d44ec 100644 --- a/README.md +++ b/README.md @@ -224,7 +224,7 @@ While all options internally are the same type, there are several ways to add an app.add_option(option_name, help_str="") app.add_option(option_name, - variable_to_bind_to, // bool, char(see note)๐Ÿšง, int, float, vector, enum, or string-like, or anything with a defined conversion from a string or that takes an int ๐Ÿ†•, double ๐Ÿ†•, or string in a constructor. Also allowed are tuples ๐Ÿ†•, std::array ๐Ÿ†• or std::pair ๐Ÿ†•. Also supported are complex numbers๐Ÿšง, wrapper types๐Ÿšง, and containers besides vector๐Ÿšง of any other supported type. + variable_to_bind_to, // bool, char(see note)๐Ÿšง, int, float, vector, enum, std::atomic ๐Ÿšง, or string-like, or anything with a defined conversion from a string or that takes an int ๐Ÿ†•, double ๐Ÿ†•, or string in a constructor. Also allowed are tuples ๐Ÿ†•, std::array ๐Ÿ†• or std::pair ๐Ÿ†•. Also supported are complex numbers๐Ÿšง, wrapper types๐Ÿšง, and containers besides vector๐Ÿšง of any other supported type. help_string="") app.add_option_function(option_name, @@ -245,7 +245,7 @@ app.add_flag(option_name, help_string="") app.add_flag(option_name, - variable_to_bind_to, // bool, int, float, complex, containers, enum, or string-like, or any singular object with a defined conversion from a string like add_option + variable_to_bind_to, // bool, int, float, complex, containers, enum, std::atomic ๐Ÿšง, or string-like, or any singular object with a defined conversion from a string like add_option help_string="") app.add_flag_function(option_name,