Commit 87d83914266760fe10a2bc495c2158d24379549e
Committed by
GitHub
1 parent
18478d7f
Clean up typos
Showing
1 changed file
with
5 additions
and
3 deletions
README.md
| @@ -16,19 +16,21 @@ The following attributes are what I believe are important in a CLI parser librar | @@ -16,19 +16,21 @@ The following attributes are what I believe are important in a CLI parser librar | ||
| 16 | * Easy to execute, with help, parse errors, etc. providing correct exit and details. | 16 | * Easy to execute, with help, parse errors, etc. providing correct exit and details. |
| 17 | * Easy to extend as part of a framework that provides "applications". | 17 | * Easy to extend as part of a framework that provides "applications". |
| 18 | * Human readable support for subcommands. | 18 | * Human readable support for subcommands. |
| 19 | +* Produce real values that can be used directly in code, not something you have pay compute time to look up. | ||
| 19 | 20 | ||
| 20 | The major CLI parsers out there include: | 21 | The major CLI parsers out there include: |
| 21 | 22 | ||
| 22 | -* [Boost Program Options](http://www.boost.org/doc/libs/1_63_0/doc/html/program_options.html): A great library if you already depend on Boost, it's pre-C++11 syntax is really odd and setting up the correct call in the main function is poorly documented. A simple wrapper for the Boost library (Program.hpp) is provided in this package if you already link to Boost. | 23 | +* [Boost Program Options](http://www.boost.org/doc/libs/1_63_0/doc/html/program_options.html): A great library if you already depend on Boost, its pre-C++11 syntax is really odd and setting up the correct call in the main function is poorly documented. A simple wrapper for the Boost library (Program.hpp) was originally developed, but has been discarded in favor of CLI11. |
| 23 | * [The Lean Mean C++ Option Parser](http://optionparser.sourceforge.net): One header file is great, but the syntax is atrocious, IMO. | 24 | * [The Lean Mean C++ Option Parser](http://optionparser.sourceforge.net): One header file is great, but the syntax is atrocious, IMO. |
| 24 | * [TCLAP](http://tclap.sourceforge.net): Not quite standard command line parsing, seems to not be well supported anymore. Header only, but in quite a few files. Not even moved to GitHub yet. | 25 | * [TCLAP](http://tclap.sourceforge.net): Not quite standard command line parsing, seems to not be well supported anymore. Header only, but in quite a few files. Not even moved to GitHub yet. |
| 25 | -* [Cxxopts](https://github.com/jarro2783/cxxopts): C++ 11, single file, and nice CMake support, but requires regex, therefore GCC 4.8 (CentOS 7 default) does not work. Syntax closely based on Boost PO. | 26 | +* [Cxxopts](https://github.com/jarro2783/cxxopts): C++ 11, single file, and nice CMake support, but requires regex, therefore GCC 4.8 (CentOS 7 default) does not work. Syntax closely based on Boost PO, so not ideal but familiar. |
| 26 | 27 | ||
| 27 | So, this library was designed to provide a great syntax, good compiler compatibility, and minimal installation fuss. | 28 | So, this library was designed to provide a great syntax, good compiler compatibility, and minimal installation fuss. |
| 28 | 29 | ||
| 29 | ## Installing | 30 | ## Installing |
| 30 | 31 | ||
| 31 | -To use, there are two methods. | 32 | +To use, there are two methods: |
| 33 | + | ||
| 32 | 1. Copy `CLI11.hpp` from the [most recent release](https://github.com/henryiii/CLI11/releases) into your include directory, and you are set. This is combined from the source files for every release. | 34 | 1. Copy `CLI11.hpp` from the [most recent release](https://github.com/henryiii/CLI11/releases) into your include directory, and you are set. This is combined from the source files for every release. |
| 33 | 2. Checkout the repository and add as a subdirectory for CMake. You can use the CLI interface target. (CMake 3.4+ recommended) | 35 | 2. Checkout the repository and add as a subdirectory for CMake. You can use the CLI interface target. (CMake 3.4+ recommended) |
| 34 | 36 |