From 82d29c7c6bd550a67eb3d300ef8a5e786a5a8a0d Mon Sep 17 00:00:00 2001 From: Nick Slowinski Date: Fri, 7 Jul 2023 18:45:45 +0200 Subject: [PATCH] add readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..87a3a10 --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# Wichtige Information + +Diese Dokumentation wird momentan mit [Sphinx](https://www.sphinx-doc.org) neugeschrieben und kann daher Lücken von wichtigen Informationen aufweisen. + +# Entwicklungsumgebung einrichten + +Python venv wird empfohlen! + +1. Repo auf lokalen PC klonen +2. Python venv installieren +3. virtuelle Umgebung erstellen: ``python -m venv .venv`` +4. virtuelle Umgebung aktivieren: ``source venv/bin/activate`` +5. Pakete installieren: ``pip install -r requirements.txt`` +6. Optional: virtuelle Umgebung deaktivieren: ``deactivate`` \ No newline at end of file