mirrors/pferd
1
0
Fork 0
mirror of https://github.com/Garmelon/PFERD.git synced 2023-12-21 10:23:01 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add example setup steps

Browse Source
This commit is contained in:
Joscha 2019-04-25 19:30:02 +00:00
parent f1ba618378
commit 5e9ecd3ce1
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -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
```