diff --git a/README.md b/README.md index 1129e09..d25c4de 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,14 @@ $ pip install git+https://github.com/Garmelon/PFERD@v0.1.0 ``` The use of [venv](https://docs.python.org/3/library/venv.html) is recommended. + +A full example setup and initial use could look like: +``` +$ mkdir Vorlesungen +$ cd Vorlesungen +$ python3 -m venv . +$ . bin/activate +$ pip install git+https://github.com/Garmelon/PFERD@v0.1.0 +$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/master/example_config.py +$ python example_config.py +```