From d8d7fce5cc30c1ff0c1b9aa29036d783faddd7f0 Mon Sep 17 00:00:00 2001 From: onyx-and-iris Date: Sun, 29 Jun 2025 16:42:08 +0100 Subject: [PATCH] reorganise readme --- README.md | 51 +++++++++++++++++++++++++-------------------------- 1 file changed, 25 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 1534536..e5b177d 100644 --- a/README.md +++ b/README.md @@ -49,28 +49,18 @@ OBS_THEME=Reds ## Use -### GUI - -To launch the GUI run the root command without any subcommands: - -```console -simple-recorder -``` - -![simple-recorder](./img/simple-recorder.png) - -Just enter the filename and click *Start*. - -#### Themes - -You can change the colour theme with the --theme option: - -```console -simple-recorder --theme="Light Purple" -``` - ### CLI +To launch the CLI pass any subcommand, for example: + +```console +simple-recorder start "File Name" + +simple-recorder stop +``` + +#### Commands: + ```shell Usage: simple-recorder [OPTIONS] COMMAND @@ -91,15 +81,24 @@ Usage: simple-recorder [OPTIONS] COMMAND ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ ``` -To launch the CLI pass any subcommand (start/stop etc...), for example: +### GUI + +To launch the GUI run the root command without any subcommands: ```console -simple-recorder start "File Name" - -simple-recorder stop +simple-recorder ``` -- If no filename is passed to start then you will be prompted for one. - - A default_name will be used if none is supplied to the prompt. +![simple-recorder](./img/simple-recorder.png) + +Just enter the filename and click *Start*. + +#### Themes + +You can change the colour theme with the --theme option: + +```console +simple-recorder --theme="Light Purple" +``` [obs-studio]: https://obsproject.com/ \ No newline at end of file