Documentation about CLI

This commit is contained in:
Luc Timmerman
2022-11-23 14:59:42 +01:00
parent b964a8b012
commit 133c367103
2 changed files with 88 additions and 9 deletions

View File

@@ -31,6 +31,12 @@ crash*. It doesn't necessarily mean it will run well on your system ;) It featur
of preference, and you *could* even use both, although this is probably a waste of resources.
## Using
### Using the CLI
To make things easier, a CLI has been developed. First, clone the repository in a directory of your
choosing. You can run it by entering `python main.py` and the CLI will guide you through the
process.
### Manually
1. To get started, clone the repository in a directory of your choosing. **Note: this will be where
your installation and media will be as well, so think about this a bit.**
2. Copy `.env.sample` to a real `.env` by running `$ cp .env.sample .env`.