Peter M. Groen / CLI11

Commit 9a956f1d697b1555fdbc5d99854f4032bcf1d235

Authored by Henry Fredrick Schreiner
1 parent afd7dce9

Updates to readme

Inline Side-by-side
Showing 1 changed file with 10 additions and 3 deletions
README.md
  View file @9a956f1
... ... @@ -6,7 +6,7 @@
6 6 # CLI11: Command line parser for C++11
7 7  
8 8 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.
9   -It is tested on [Travis with a suite of tests](https://travis-ci.org/henryiii/CLI11), and is being included in the [GooFit GPU fitting framework](https://GooFit.github.io). It was inspired by [`plumbum.cli`](http://plumbum.readthedocs.io/en/latest/) for Python. It has both a user friendly introduction here, as well as [API documentation](https://henryiii.github.io/CLI11/index.html) generated by Travis.
  9 +It is tested on [Travis](https://travis-ci.org/henryiii/CLI11) and [Appveyor](https://ci.appveyor.com/project/HenrySchreiner/cli11), and is being included in the [GooFit GPU fitting framework](https://GooFit.github.io). It was inspired by [`plumbum.cli`](http://plumbum.readthedocs.io/en/latest/) for Python. It has both a user friendly introduction here, as well as [API documentation](https://henryiii.github.io/CLI11/index.html) generated by Travis.
10 10  
11 11 ### Why write another CLI parser?
12 12  
... ... @@ -37,15 +37,22 @@ So, this library was designed to provide a great syntax, good compiler compatibi
37 37  
38 38 This library was built to supply the Application object for the GooFit CUDA/OMP fitting library. Before version 2.0 of GooFit is released, this library will reach version 1.0 status. The current tasks still planned are:
39 39  
40   -* Expand tests to include a few more features
41 40 * Collect user feedback
42 41 * Ini configuration support is basic (long options only, no vector support), is more needed?
43 42 * Evaluate compatibility with [ROOT](https://root.cern.ch)'s TApplication object.
44   -* Document adding callback (maybe add C++14 only `add_switch` method?)
45 43 * Test "adding to cmake" method
46 44  
47 45 See the [changelog](./CHANGELOG.md) or [GitHub releases](https://github.com/henryiii/CLI11/releases) for details.
48 46  
  47 +## Things not supported by this library
  48 +
  49 +As you probably have guessed, the list of features above are all covered by this library. There are some other features that are intentionally not supported by this library:
  50 +
  51 +* Non-standard variations on syntax, like `-long` options. This is non-standard and should be avoided, so that is enforced by this library.
  52 +* Completion of partial options, such as Python's `argparse` supplies for incomplete arguments. It's better not to guess.
  53 +* In C++14, you could have a set of `callback` methods (tested in branch). Not deemed worth having a C++14 variation on API.
  54 +* Autocomplete: This might eventually be added to both Plumbum and CLI11, but it is not supported yet.
  55 +
49 56  
50 57 ## Installing
51 58  
... ...