pferd/README.md
Joscha 27e4abcfa3 Do project setup from scratch
Following guidelines from the Python Packaging User Guide [1].

This commit intentionally breaks the .gitignore, project dependencies, GitHub
Actions and other stuff. It also removes almost the entire README. The intention
behind this is to get rid of all cruft that as accumulated over time and to have
a fresh start. Only necessary things will be re-added as they're needed.

From now on, I also plan on adding documentation for every feature at the same
time that the feature is implemented. This is to ensure that the documentation
does not become outdated.

[1]: https://packaging.python.org/
2021-04-27 00:07:54 +02:00

19 lines
446 B
Markdown

# PFERD
**P**rogramm zum **F**lotten, **E**infachen **R**unterladen von **D**ateien
Other resources:
- [Development Guide](DEV.md)
## Installation with pip
Ensure you have at least Python 3.8 installed. Run the following command to
install PFERD or upgrade it to the latest version:
```
$ pip install --upgrade git+https://github.com/Garmelon/PFERD@latest
```
The use of [venv](https://docs.python.org/3/library/venv.html) is recommended.