master > master: README

README.md

@@ -29,6 +29,27 @@ Im Unterordner [`code`](./code) kann man ein Python-Projekt finden, in dem versc
 Man kann gerne den Code benutzen, in einer eigenen Repository verändern,
 und mit den in dem Kurs präsentierten Algorithmen herumexperimentieren.
 
+### Systemvoraussetzungen ###
+
+Python version 3.x.x (idealerweise zumindest 3.9.5) plus folgende Module:
+
+- argparse>=1.4.0
+- pyyaml>=5.4.1
+- typing>=3.7.4.3
+
+(ACHTUNG: diese Liste könnte später im Kurs länger werden)
+
+Diese lassen sich mittels
+```bash
+python3 -m pip install {name des Moduls} # linux, osx
+py -3 -m pip install {name des Moduls} # Windows
+```
+installieren.
+Man kann auch die Version mittels etwa `{name}==1.2.3` oder `{name}>=1.2.3` spezifizieren.
+Alternativ verwende man `python3 -m pip install --upgrade {name}` bzw. `py -3 ...`.
+
+### Ausführung ###
+
 Um den Python Code auszuführen, bspw. im Bash:
 ```bash
 python3 code/main.py all; # linux, OSX

code/local/system.py

@@ -8,7 +8,5 @@
 import os;
 import sys;
 
-import pathlib;
 import platform;
 import shutil;
-import subprocess;

code/main.py

@@ -107,7 +107,10 @@ if __name__ == '__main__':
     cli_args = sys.argv[1:];
     parser = argparse.ArgumentParser(
         prog='code/main.py',
-        description=r'Ein Programm, das verschiedene Algorithmen aus dem Kurs AlgoDat I testet.'
+        description='''
+            \033[2;1mBeschreibung:\033[0m
+            \033[2mEin Programm, das verschiedene Algorithmen aus dem Kurs AlgoDat I testet.\033[0m
+            ''',
     );
     parser.add_argument('all',    nargs='?',                  help='Führt alle Testfälle in der config.yml Datei durch.');
     parser.add_argument('--path', nargs=1, type=str,          help='Pfad zur alternativen Configdatei.');