simonkellet/odin-flags
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added doc for custom flag foramt

Browse Source
This commit is contained in:
Simon Kellet 2026-07-09 16:36:04 +01:00
parent 49eaaeabf5
commit c675f6b659
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -28,9 +28,9 @@ And on the command line, you pass flags like so:
./<program name> -isNumber=45 -isRunning=false ......
```
## Usage flag: -help
## Help flag:
The package also contains a help context menu. This comes default and can be called like so
The package also contains a help context menu. This comes default and can be called like so (**Note:** You can also use "-h" or "--help"):
```txt
./<program name> -help
@ -52,6 +52,10 @@ The package also contains a help context menu. This comes default and can be cal
**Note:** You can set the boolean *FORCE_HELP_ON_EMPTY_ARGS* to allow for the help context menu to be displayed when no arguments are passed
## Custom Flag Format
A custom flag format can be created by overwriting the strings *FLAG_START_CHAR* and *FLAG_SEP_CHAR*. These cannot be the same however!
## Custom Allocator
If needed, you are able to setup a custom allocator like so: