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

Update README.md

Browse Source
This commit is contained in:
Pranav Srinivas Kumar 2019-03-31 11:43:24 -04:00 committed by GitHub
parent 9e1c0bbc2f
commit 0c71e3c6f2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -6,7 +6,9 @@
* Requires C++17
* MIT License
## Positional Arguments
## Examples
### Positional Arguments
```cpp
argparse::ArgumentParser program("main");
@ -20,7 +22,7 @@ std::string input = program.get("input"); // "rocket.msh"
std::string output = program.get("output"); // "thrust_profile.csv"
```
## Optional Arguments
### Optional Arguments
```cpp
argparse::ArgumentParser program("main");
@ -39,7 +41,7 @@ std::string config = program.get("--config"); // "config.json"
int num_iterations = program.get<int>("-n"); // 36
```
## Vector of Arguments
### Vector of Arguments
```cpp
argparse::ArgumentParser program("main");
@ -53,7 +55,7 @@ program.parse_args({"./main", "--input_files", "config.yml", "System.xml"});
auto files = program.get<std::vector<std::string>>("--input_files"); // {"config.yml", "System.xml"}
```
## Toggle Arguments
### Toggle Arguments
```cpp
argparse::ArgumentParser program("test");
@ -67,7 +69,7 @@ program.parse_args({ "./main", "--verbose" });
auto a = program.get<bool>("--verbose"); // true
```
## Compound Arguments
### Compound Arguments
```cpp
argparse::ArgumentParser program("test");
@ -91,7 +93,7 @@ auto b = program.get<bool>("-b"); // true
auto c = program.get<std::vector<float>>("-c"); // {3.14f, 2.718f}
```
## Positional Arguments with Compound Toggle Arguments
### Positional Arguments with Compound Toggle Arguments
```cpp
argparse::ArgumentParser program("test");
@ -124,3 +126,22 @@ auto b = program.get<bool>("-b"); // true
auto c = program.get<std::vector<float>>("-c"); // {3.14f, 2.718f}
auto files = program.get<std::vector<std::string>>("--files"); // {"a.txt", "b.txt", "c.txt"}
```
### Construct class objects from arguments
```cpp
argparse::ArgumentParser program("json_test");
program.add_argument("config")
.action([](const std::string& value) {
// read a JSON file
std::ifstream stream(value);
nlohmann::json config_json;
stream >> config_json;
return config_json;
});
program.parse_args({"./test", "config.json"});
nlohmann::json config = program.get<nlohmann::json>("config");
```