From 0bda368f59cc74a7850e888d5157d8d2fe737934 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Fri, 28 Jun 2024 03:04:14 +0100 Subject: [PATCH] add -h flag to help dialogue add -h flag to Use section in README update example markdown in README --- README.md | 17 +++++++++++++---- src/vmrcli.c | 3 ++- 2 files changed, 15 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5a3ba0e..50dad9c 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,13 @@ ## `Use` -`./vmrcli.exe [-i] [-k] [-D] ` +```powershell +./vmrcli.exe [-h] [-i] [-k] [-D] +``` Where: +- `h`: Prints the help dialogue. - `i`: Enable interactive mode. If set, any api commands passed on the command line will be ignored. - `k`: The kind of Voicemeeter (basic, banana or potato). Use this to launch the GUI. - `D`: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL @@ -30,17 +33,23 @@ Examples: Launch basic GUI, set log level to INFO, Toggle Strip 0 Mute, then print its new value -`./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute` +```powershell +./vmrcli.exe -kbasic -D2 !strip[0].mute strip[0].mute +``` Launch banana GUI, set log level to DEBUG, set Strip 0 label to podmic then print Strip 2 label -`./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label` +```powershell +./vmrcli.exe -kbanana -D1 strip[0].label=podmic strip[2].label +``` ## `Interactive Mode` Running the following command in Powershell: -`./vmrcli.exe -i` +```powershell +./vmrcli.exe -i +``` Will open an interactive prompt: diff --git a/src/vmrcli.c b/src/vmrcli.c index 4dc34f4..5363ec4 100644 --- a/src/vmrcli.c +++ b/src/vmrcli.c @@ -112,8 +112,9 @@ int main(int argc, char *argv[]) void help() { puts( - "Usage: ./vmrcli.exe [-i] [-k] [-D] \n" + "Usage: ./vmrcli.exe [-h] [-i] [-k] [-D] \n" "Where: \n" + "\th: Prints the help dialogue\n" "\ti: Enable interactive mode\n" "\tk: The kind of Voicemeeter (basic, banana, potato)\n" "\tD: Set log level 0=TRACE, 1=DEBUG, 2=INFO, 3=WARN, 4=ERROR, 5=FATAL");