leonetienne/Hazelnupp
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

Readme.md

Browse Source
This commit is contained in:
Leonetienne 2021-06-03 16:39:43 +02:00
parent 27879c40b6
commit 01143ac299
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
readme.md
View File

@ -71,6 +71,7 @@ These parameters can then be accessed via a simple lookup!
So what's the simplest way to use Hazelnupp to work with command-line parameters? See: So what's the simplest way to use Hazelnupp to work with command-line parameters? See:
```cpp ```cpp
#include "Hazelnupp.h" #include "Hazelnupp.h"
using namespace Hazelnp;
int main(int argc, char** argv) int main(int argc, char** argv)
{ {
@ -88,6 +89,7 @@ int main(int argc, char** argv)
Looks super easy! But what about actual values? Looks super easy! But what about actual values?
```cpp ```cpp
#include "Hazelnupp.h" #include "Hazelnupp.h"
using namespace Hazelnp;
int main(int argc, char** argv) int main(int argc, char** argv)
{ {
@ -97,7 +99,7 @@ int main(int argc, char** argv)
try try
{ {
int myInt = args["--my-int"].GetInt32(); int myInt = args["--my-int"].GetInt32();
double myInt = args["--my-float"].GetFloat32(); double myFlt = args["--my-float"].GetFloat32();
std::string myStr = args["--my-string"].GetString(); std::string myStr = args["--my-string"].GetString();
} }
catch (HazelnuppInvalidKeyException&) catch (HazelnuppInvalidKeyException&)
@ -112,6 +114,7 @@ int main(int argc, char** argv)
What about lists? What about lists?
```cpp ```cpp
#include "Hazelnupp.h" #include "Hazelnupp.h"
using namespace Hazelnp;
int main(int argc, char** argv) int main(int argc, char** argv)
{ {
@ -134,6 +137,7 @@ Abbreviations are a very important part of command line arguments. Like, typing
Here's how to use them in Hazelnupp: Here's how to use them in Hazelnupp:
```cpp ```cpp
#include "Hazelnupp.h" #include "Hazelnupp.h"
using namespace Hazelnp;
int main(int argc, char** argv) int main(int argc, char** argv)
{ {
@ -167,6 +171,7 @@ With `ParamConstraint::Require()` you can declare that a paramater must either a
Minimal working example: Minimal working example:
```cpp ```cpp
#include "Hazelnupp.h" #include "Hazelnupp.h"
using namespace Hazelnp;
int main(int argc, char** argv) int main(int argc, char** argv)
{ {
@ -204,6 +209,7 @@ The `*->void` conversions just drop their value.
Minimal working example: Minimal working example:
```cpp ```cpp
#include "Hazelnupp.h" #include "Hazelnupp.h"
using namespace Hazelnp;
int main(int argc, char** argv) int main(int argc, char** argv)
{ {