mirrors/CLI11
1
0
Fork 0
mirror of https://github.com/CLIUtils/CLI11.git synced 2025-04-30 12:43:52 +00:00
Code Issues Releases Wiki Activity

Adding note and blog post mention

Browse Source
This commit is contained in:
Henry Fredrick Schreiner 2017-06-01 17:11:41 -04:00
parent a187ec23e8
commit 0eae4fe5d3
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -8,8 +8,7 @@
CLI11 provides all the features you expect in a powerful command line parser, with a beautiful, minimal syntax and no dependencies beyond C++11. It is header only, and comes in a single file form for easy inclusion in projects. It is easy to use for small projects, but powerful enough for complex command line projects, and can be customized for frameworks. CLI11 provides all the features you expect in a powerful command line parser, with a beautiful, minimal syntax and no dependencies beyond C++11. It is header only, and comes in a single file form for easy inclusion in projects. It is easy to use for small projects, but powerful enough for complex command line projects, and can be customized for frameworks.
It is tested on [Travis] and [AppVeyor], and is being included in the [GooFit GPU fitting framework][GooFit]. It was inspired by [`plumbum.cli`][Plumbum] for Python. CLI11 has both a user friendly introduction here, as well as [API documentation][api-docs] generated by Travis. It is tested on [Travis] and [AppVeyor], and is being included in the [GooFit GPU fitting framework][GooFit]. It was inspired by [`plumbum.cli`][Plumbum] for Python. CLI11 has both a user friendly introduction here, as well as [API documentation][api-docs] generated by Travis.
See the [changelog](./CHANGELOG.md) or [GitHub Releases] for details for current and past releases. See the [changelog](./CHANGELOG.md) or [GitHub Releases] for details for current and past releases. The 1.0 announcement post can be found [here](http://iscinumpy.blogspot.com/2017/06/announcing-cli11-version-10.html).
### Why write another CLI parser? ### Why write another CLI parser?
@ -236,12 +235,6 @@ app.add_option("--fancy-count", [](std::vector<std::string> val){
}); });
``` ```
## Contributing
To contribute, open an [issue][Github Issues] or [pull request][Github Pull Requests] on GitHub, or ask a question on [gitter].
As of version 1.0, this library is available under a 3-Clause BSD license. See the [LICENSE](./LICENSE) file for details.
## Utilities ## Utilities
There are a few other utilities that are often useful in CLI programming. These are in separate headers, and do not appear in `CLI11.hpp`, but are completely independent and can be used as needed. The `Timer`/`AutoTimer` class allows you to easily time a block of code, with custom print output. There are a few other utilities that are often useful in CLI programming. These are in separate headers, and do not appear in `CLI11.hpp`, but are completely independent and can be used as needed. The `Timer`/`AutoTimer` class allows you to easily time a block of code, with custom print output.
@ -272,6 +265,14 @@ try {
This will print help in blue, errors in red, and will reset before returning the terminal to the user. This will print help in blue, errors in red, and will reset before returning the terminal to the user.
## Contributing
To contribute, open an [issue][Github Issues] or [pull request][Github Pull Requests] on GitHub, or ask a question on [gitter].
As of version 1.0, this library is available under a 3-Clause BSD license. See the [LICENSE](./LICENSE) file for details.
CLI11 was developed at the [University of Cincinnati] to support of the [GooFit] library under [NSF Award 1414736]. It was featured in a [DIANA/HEP] meeting at CERN. Please give it a try! Feedback is always welcome.
[travis-badge]: https://img.shields.io/travis/CLIUtils/CLI11/master.svg?label=Linux/macOS [travis-badge]: https://img.shields.io/travis/CLIUtils/CLI11/master.svg?label=Linux/macOS
[Travis]: https://travis-ci.org/CLIUtils/CLI11 [Travis]: https://travis-ci.org/CLIUtils/CLI11
@ -285,7 +286,7 @@ This will print help in blue, errors in red, and will reset before returning the
[Github Releases]: https://github.com/CLIUtils/CLI11/releases [Github Releases]: https://github.com/CLIUtils/CLI11/releases
[Github Issues]: https://github.com/CLIUtils/CLI11/issues [Github Issues]: https://github.com/CLIUtils/CLI11/issues
[Github Pull Requests]: https://github.com/CLIUtils/CLI11/pulls [Github Pull Requests]: https://github.com/CLIUtils/CLI11/pulls
[Goofit]: https://GooFit.github.io [GooFit]: https://GooFit.github.io
[Plumbum]: https://plumbum.readthedocs.io/en/latest/ [Plumbum]: https://plumbum.readthedocs.io/en/latest/
[Click]: http://click.pocoo.org [Click]: http://click.pocoo.org
[api-docs]: https://CLIUtils.github.io/CLI11/index.html [api-docs]: https://CLIUtils.github.io/CLI11/index.html
@ -299,4 +300,6 @@ This will print help in blue, errors in red, and will reset before returning the
[cltools-cmake]: https://github.com/CLIUtils/cmake [cltools-cmake]: https://github.com/CLIUtils/cmake
[GFlags]: https://gflags.github.io/gflags [GFlags]: https://gflags.github.io/gflags
[GetOpt]: https://www.gnu.org/software/libc/manual/html_node/Getopt.html [GetOpt]: https://www.gnu.org/software/libc/manual/html_node/Getopt.html
[DIANA/HEP]: http://diana-hep.org
[NSF Award 1414736]: https://nsf.gov/awardsearch/showAward?AWD_ID=1414736
[University of Cincinnati]: http://www.uc.edu