improve readme
This commit is contained in:
parent
466acbd760
commit
dbbbd3a43d
1 changed files with 18 additions and 2 deletions
20
README.md
20
README.md
|
|
@ -1,4 +1,4 @@
|
||||||
# Clone
|
# GIT Clone
|
||||||
|
|
||||||
To clone with submodules, use these git commands:
|
To clone with submodules, use these git commands:
|
||||||
|
|
||||||
|
|
@ -8,7 +8,23 @@ git submodule update --init // add submodule after normal cloning
|
||||||
git submodule update --remote // update submodules
|
git submodule update --remote // update submodules
|
||||||
```
|
```
|
||||||
|
|
||||||
# Run
|
# Run without Docker
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
Create a python environment and install all dependencies via
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Run the script with
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python main.py
|
||||||
|
```
|
||||||
|
|
||||||
|
# Run with Docker
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose build
|
docker compose build
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue