mirror of
https://github.com/Garmelon/PFERD.git
synced 2023-12-21 10:23:01 +01:00
27e4abcfa3
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/
1.5 KiB
1.5 KiB
PFERD Development Guide
PFERD is packaged following the Python Packaging User Guide (in particular this and this guide).
Setting up a dev environment
The use of venv is recommended. To initially set up a development environment, run these commands in the same directory as this file:
$ python -m venv .venv
$ . .venv/bin/activate
$ pip install --editable .
After this, you can use PFERD as if it was installed normally. Since PFERD was
installed with --editable, there is no need to re-run pip install when the
source code is changed.
For more details, see this part of the Python Tutorial and this section on "development mode".
Contributing
When submitting a PR that adds, changes or modifies a feature, please ensure that the corresponding documentation is updated.
In your first PR, please add your name to the LICENSE file.