KeqingMoe/argparse
1
0
Fork 0
mirror of https://github.com/KeqingMoe/argparse.git synced 2025-07-04 23:24:39 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Replace spaces with underscores in example program names

Browse Source 
These examples give a false impression that a space in the middle of the
application name is well handled.  While a space might be possible, it
must be escaped in shells, i.e. a common environment for a CLI argument
parser.

Signed-off-by: Sean Robinson <sean.robinson@scottsdalecc.edu>
This commit is contained in:
Sean Robinson 2021-10-26 12:58:24 -07:00
parent 8772b37aab
commit 58777d8c84
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -27,7 +27,7 @@ Simply include argparse.hpp and you're good to go.
To start parsing command-line arguments, create an ```ArgumentParser```. To start parsing command-line arguments, create an ```ArgumentParser```.
```cpp ```cpp
argparse::ArgumentParser program("program name"); argparse::ArgumentParser program("program_name");
``` ```
**NOTE:** There is an optional second argument to the `ArgumentParser` which is the program version. Example: `argparse::ArgumentParser program("libfoo", "1.9.0");` **NOTE:** There is an optional second argument to the `ArgumentParser` which is the program version. Example: `argparse::ArgumentParser program("libfoo", "1.9.0");`
@ -49,7 +49,7 @@ Here's an example of a ***positional argument***:
#include <argparse/argparse.hpp> #include <argparse/argparse.hpp>
int main(int argc, char *argv[]) { int main(int argc, char *argv[]) {
argparse::ArgumentParser program("program name"); argparse::ArgumentParser program("program_name");
program.add_argument("square") program.add_argument("square")
.help("display the square of a given integer") .help("display the square of a given integer")