From c675f6b659adb17c07d49e1ef130653b06584b7b Mon Sep 17 00:00:00 2001 From: Simon Kellet Date: Thu, 9 Jul 2026 16:36:04 +0100 Subject: [PATCH] added doc for custom flag foramt --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 41dd524..c65a517 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,9 @@ And on the command line, you pass flags like so: ./ -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 ./ -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: