pferd/README.md
2019-04-25 20:01:50 +00:00

35 lines
829 B
Markdown

# PFERD
**P**rogramm zum **F**lotten, **E**infachen **R**unterladen von **D**ateien
## Installation
Ensure that you have at least Python 3.7 installed.
To install PFERD or update your installation to the latest version, run:
```
$ pip install git+https://github.com/Garmelon/PFERD@v1.0.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@v1.0.0
$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/master/example_config.py
$ python3 example_config.py
$ deactivate
```
Subsequent runs of the program might look like:
```
$ cd Vorlesungen
$ . bin/activate
$ python3 example_config.py
$ deactivate
```