diff --git a/README.md b/README.md index b0c48c8..efc6b2b 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,8 @@ Siehe Moodle! ## Code ## -Im Unterordner [`code/rust`](./code/rust) -(und evtl. [`code/python`](./code/python)) -werden ggf. Implementierungen von den Algorithmen zu finden sein. +In den Unterordnern + [`code/rust`](./code/rust) + und + [`code/python`](./code/python) (etwas ausführlicher) +sind Implementierungen von einigen Algorithmen bzw. Datenstrukturen zu finden sein. diff --git a/code/python/README.md b/code/python/README.md index 86c7ff1..196f454 100644 --- a/code/python/README.md +++ b/code/python/README.md @@ -10,7 +10,7 @@ die Methoden mit Daten ausprobieren. ## Voraussetzungen ## 1. Der Python-Compiler **`^3.10.*`** wird benötigt. -2. Es ist auch empfehlenswert, **`justfile`** zu installieren (siehe ). +2. Das **`justfile`**-Tool wird benötigt (siehe ). ## Build -> Test -> Run ## @@ -18,29 +18,18 @@ In einem IDE in dem Repo zu diesem Ordner navigieren.
Eine bash-Konsole aufmachen und folgende Befehle ausführen: -Wer das **justfile**-Tool hat: ```bash # Zeige alle Befehle: just -# Zur Installation der Requirements (nur nach Änderungen): -just build; +# Zur Installation der Requirements (nur und immer nach Änderungen nötig): +just build # Zur Ausführung der unit tests: -just tests; +just tests # Zur Ausführung des Programms -just run; +just run # Zur Bereinigung aller Artefakte -just clean; +just clean ``` -Wer das justfile-Tool hat: -```bash -# Zur Installation der Requirements (nur nach Änderungen): -python3 -m pip install -r requirements.txt; -# Zur Ausführung der unit tests: -python3 -m pytest tests --cache-clear --verbose -k test_; -# Zur Ausführung des Programms: -python3 main.py -``` -Auf Windows verwendet man `py -3` od. `py -310` statt `python3`. Man kann auch mit einem guten Editor/IDE die Tests einzeln ausführen.