Better links and one more mention

Henry Fredrick Schreiner
1 parent 1619e863
Showing 1 changed file with 33 additions and 31 deletions
README.md
-[![Build Status Linux and macOS][travis-badge]][travis-link]
-[![Build Status Windows][appveyor-badge]][appveyor-link]
-[![Code Coverage][codecov-badge]][codecov-link]
-[![Join the chat at https://gitter.im/CLI11gitter/Lobby][gitter-badge]][gitter-link]
+[![Build Status Linux and macOS][travis-badge]][Travis]
+[![Build Status Windows][appveyor-badge]][AppVeyor]
+[![Code Coverage][codecov-badge]][CodeCov]
+[![Join the chat at https://gitter.im/CLI11gitter/Lobby][gitter-badge]][gitter]
 [![License: LGPL v2.1][license-badge]](./LICENSE)
  
 # CLI11: Command line parser for C++11
  
 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][travis-link] and [AppVeyor][appveyor-link], and is being included in the [GooFit GPU fitting framework][goofit-link]. It was inspired by [`plumbum.cli`][plumbum-link] 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.
  
  
 ### Why write another CLI parser?
@@ -18,7 +18,7 @@ An acceptable CLI parser library should be all of the following:
 * Short Syntax: This is one of the main points of a CLI parser, it should make variables from the command line nearly as easy to define as any other variables. If most of your program is hidden in CLI parsing, this is a problem for readability.
 * C++11 or better: Should work with GCC 4.7+ (such as GCC 4.8 on CentOS 7) or above, or Clang 3.5+, or MSVC 2015+. (Note: for CLI11, Clang 3.4 only fails because of tests, GoogleMock does not support it.)
 * Work on Linux, macOS, and Windows.
-* Well tested using [Travis][travis-link] (Linux and macOS) and [AppVeyor][appveyor-link] (Windows). "Well" is defined as having good coverage measured by [CodeCov][codecov-link].
+* Well tested using [Travis] (Linux and macOS) and [AppVeyor] (Windows). "Well" is defined as having good coverage measured by [CodeCov].
 * Clear help printing.
 * Standard shell idioms supported naturally, like grouping flags, a positional separator, etc.
 * Easy to execute, with help, parse errors, etc. providing correct exit and details.
@@ -30,10 +30,11 @@ An acceptable CLI parser library should be all of the following:
  
 The major CLI parsers for C++ include:
  
-* [Boost Program Options][boost-link]: A great library if you already depend on Boost, but its pre-C++11 syntax is really odd and setting up the correct call in the main function is poorly documented (and is nearly a page of code). A simple wrapper for the Boost library was originally developed, but was discarded as CLI11 became more powerful. The idea of capturing a value and setting it originated with Boost PO.
-* [The Lean Mean C++ Option Parser][optionparser-link]: One header file is great, but the syntax is atrocious, in my opinion. It was quite impractical to wrap the syntax or to use in a complex project. It seems to handle standard parsing quite well.
-* [TCLAP][tclap-link]: The not-quite-standard command line parsing causes common shortcuts to fail. It also seems to be poorly supported, with only minimal bugfixes accepted. Header only, but in quite a few files. Has not managed to get enough support to move to GitHub yet. No subcommands. Produces wrapped values.
-* [Cxxopts][cxxopts-link]: 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.
+* [Boost Program Options]: A great library if you already depend on Boost, but its pre-C++11 syntax is really odd and setting up the correct call in the main function is poorly documented (and is nearly a page of code). A simple wrapper for the Boost library was originally developed, but was discarded as CLI11 became more powerful. The idea of capturing a value and setting it originated with Boost PO.
+* [The Lean Mean C++ Option Parser]: One header file is great, but the syntax is atrocious, in my opinion. It was quite impractical to wrap the syntax or to use in a complex project. It seems to handle standard parsing quite well.
+* [TCLAP]: The not-quite-standard command line parsing causes common shortcuts to fail. It also seems to be poorly supported, with only minimal bugfixes accepted. Header only, but in quite a few files. Has not managed to get enough support to move to GitHub yet. No subcommands. Produces wrapped values.
+* [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.
+* [DocOpt]: Completely different approach to program options in C++11, you write the docs and the interface is generated. Too fragile and specialized. 
  
 So, this library was designed to provide a great syntax, good compiler compatibility, and minimal installation fuss.
  
@@ -42,9 +43,9 @@ So, this library was designed to provide a great syntax, good compiler compatibi
 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:
  
 * Collect user feedback
-* Evaluate compatibility with [ROOT][root-link]'s TApplication object.
+* Evaluate compatibility with [ROOT]'s TApplication object.
  
-See the [changelog](./CHANGELOG.md) or [GitHub releases][github-releases] for details.
+See the [changelog](./CHANGELOG.md) or [GitHub Releases] for details.
  
 ## Features not supported by this library
  
@@ -60,7 +61,7 @@ As you probably have guessed, the list of features above are all covered by this
  
 To use, there are two methods:
  
-1. Copy `CLI11.hpp` from the [most recent release][github-releases] into your include directory, and you are set. This is combined from the source files  for every release. This includes the entire command parser library, but does not include separate utilities (like `Timer`, `AutoTimer`). The utilities are completely self contained and can be copied separately.
+1. Copy `CLI11.hpp` from the [most recent release][Github-releases] into your include directory, and you are set. This is combined from the source files  for every release. This includes the entire command parser library, but does not include separate utilities (like `Timer`, `AutoTimer`). The utilities are completely self contained and can be copied separately.
 2. Checkout the repository and add as a subdirectory for CMake. You can use the `cli` interface target when linking. (CMake 3.4+ recommended) Or, use the `AddCLI.cmake` supplied in [CLIUtils cmake helpers][cltools-cmake]. 
  
 To build the tests, checkout the repository and use CMake:
@@ -235,7 +236,7 @@ app.add_option(&quot;--fancy-count&quot;, [](std::vector&lt;std::string&gt; val){
  
 ## Contributing
  
-To contribute, open an [issue][github-issues] or [pull request][github-pull] on GitHub, or ask a question on [gitter][gitter-link].
+To contribute, open an [issue][Github Issues] or [pull request][Github Pull Requests] on GitHub, or ask a question on [gitter].
  
 ## Utilities
  
@@ -253,7 +254,7 @@ string for printing.
  
 ## Other libraries
  
-If you use the [`rang`][rang-link] library to add color to your terminal in a safe, multi-platform way, you can combine it with CLI11 nicely:
+If you use the [Rang] library to add color to your terminal in a safe, multi-platform way, you can combine it with CLI11 nicely:
  
 ```cpp
 std::atexit([](){std::cout << rang::style::reset;});
@@ -269,25 +270,26 @@ This will print help in blue, errors in red, and will reset before returning the
  
  
 [travis-badge]:      https://img.shields.io/travis/CLIUtils/CLI11/master.svg?label=Linux/macOS
-[travis-link]:       https://travis-ci.org/CLIUtils/CLI11
+[Travis]:            https://travis-ci.org/CLIUtils/CLI11
 [appveyor-badge]:    https://img.shields.io/appveyor/ci/HenrySchreiner/cli11/master.svg?label=Windows
-[appveyor-link]:     https://ci.appveyor.com/project/HenrySchreiner/cli11
+[AppVeyor]:          https://ci.appveyor.com/project/HenrySchreiner/cli11
 [codecov-badge]:     https://codecov.io/gh/CLIUtils/CLI11/branch/master/graph/badge.svg
-[codecov-link]:      https://codecov.io/gh/CLIUtils/CLI11
+[CodeCov]:           https://codecov.io/gh/CLIUtils/CLI11
 [gitter-badge]:      https://badges.gitter.im/CLI11gitter/Lobby.svg
-[gitter-link]:       https://gitter.im/CLI11gitter/Lobby
+[gitter]:            https://gitter.im/CLI11gitter/Lobby
 [license-badge]:     https://img.shields.io/badge/License-LGPL%20v2.1-blue.svg
-[github-releases]:   https://github.com/CLIUtils/CLI11/releases
-[github-issues]:     https://github.com/CLIUtils/CLI11/issues
-[github-pull]:       https://github.com/CLIUtils/CLI11/pulls
-[goofit-link]:       https://GooFit.github.io 
-[plumbum-link]:      https://plumbum.readthedocs.io/en/latest/
-[click-link]:        http://click.pocoo.org
+[Github Releases]:   https://github.com/CLIUtils/CLI11/releases
+[Github Issues]:     https://github.com/CLIUtils/CLI11/issues
+[Github Pull Requests]: https://github.com/CLIUtils/CLI11/pulls
+[Goofit]:            https://GooFit.github.io 
+[Plumbum]:           https://plumbum.readthedocs.io/en/latest/
+[Click]:             http://click.pocoo.org
 [api-docs]:          https://CLIUtils.github.io/CLI11/index.html
-[rang-link]:         https://github.com/agauniyal/rang
-[boost-link]:        http://www.boost.org/doc/libs/1_63_0/doc/html/program_options.html
-[optionparser-link]: http://optionparser.sourceforge.net
-[tclap-link]:        http://tclap.sourceforge.net
-[cxxopts-link]:      https://github.com/jarro2783/cxxopts
-[root-link]:         https://root.cern.ch
+[Rang]:              https://github.com/agauniyal/rang
+[Boost Program Options]: http://www.boost.org/doc/libs/1_63_0/doc/html/program_options.html
+[The Lean Mean C++ Option Parser]: http://optionparser.sourceforge.net
+[TCLAP]:             http://tclap.sourceforge.net
+[Cxxopts]:           https://github.com/jarro2783/cxxopts
+[DocOpt]:            https://github.com/docopt/docopt.cpp
+[ROOT]:              https://root.cern.ch
 [cltools-cmake]:     https://github.com/CLIUtils/cmake