From dbbbd3a43dd0ec98e058bb1aea5f38edb6aea059 Mon Sep 17 00:00:00 2001 From: Daniel Date: Thu, 30 Nov 2023 16:34:31 +0100 Subject: [PATCH] improve readme --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a4ffa00..eb464f1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Clone +# GIT Clone 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 ``` -# 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 docker compose build