onyx_online/simple-recorder
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/simple-recorder.git synced 2025-07-27 06:11:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

reorganise readme

Browse Source
This commit is contained in:
onyx-and-iris 2025-06-29 16:42:08 +01:00
parent ca7604c279
commit d8d7fce5cc
1 changed files with 25 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -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/