pferd/README.md

# PFERD

**P**rogramm zum **F**lotten, **E**infachen **R**unterladen von **D**ateien

Other resources:

- [Config file format](CONFIG.md)
- [Changelog](CHANGELOG.md)
- [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.
Fix backronym in README 2019-04-25 21:58:30 +02:00			`# PFERD`

			`Programm zum Flotten, Einfachen Runterladen von Dateien`
Reorganize project structure 2019-04-25 13:48:58 +02:00
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-26 23:46:44 +02:00			`Other resources:`
Improve README - Added a table of contents - Reworked the transform section - Fixed the commented example 2020-07-11 20:16:33 +02:00
Document config file format 2021-04-29 18:55:08 +02:00			`- [Config file format](CONFIG.md)`
Add changelog 2021-04-29 16:14:50 +02:00			`- [Changelog](CHANGELOG.md)`
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-26 23:46:44 +02:00			`- [Development Guide](DEV.md)`
Add sync_url instructions to README 2020-10-06 17:46:42 +02:00
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-26 23:46:44 +02:00			`## Installation with pip`
Add sync_url instructions to README 2020-10-06 17:46:42 +02:00
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-26 23:46:44 +02:00			`Ensure you have at least Python 3.8 installed. Run the following command to`
			`install PFERD or upgrade it to the latest version:`
Add sync_url instructions to README 2020-10-06 17:46:42 +02:00
Reorganize project structure 2019-04-25 13:48:58 +02:00			```
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-26 23:46:44 +02:00			`$ pip install --upgrade git+https://github.com/Garmelon/PFERD@latest`
Add example setup steps 2019-04-25 21:30:02 +02:00			```
Improve README - Added a table of contents - Reworked the transform section - Fixed the commented example 2020-07-11 20:16:33 +02:00
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-26 23:46:44 +02:00			`The use of [venv](https://docs.python.org/3/library/venv.html) is recommended.`