From 9e76b4c878ecb152ef66bed2c45b2c5d9becc241 Mon Sep 17 00:00:00 2001 From: Markus Rosenstihl Date: Sun, 9 Nov 2025 16:30:27 +0100 Subject: [PATCH] updated README --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 38aaa72..fe348b4 100644 --- a/README.md +++ b/README.md @@ -10,12 +10,30 @@ Make sure dependencies are installed: * matplotlib * numpy +### Installation from repository +This will install itudplot for your python in your local folder (so you do no break system packages, despite what "--break-system-packages" implicates) + + pip install --user --break-system-packages git+https://gitea.pkm.physik.tu-darmstadt.de/IPKM/python-tudplot.git + +Another way is to use a venv for your project: + + python3 -m venv venv + source ./venv/bin/activate + pip install git+https://gitea.pkm.physik.tu-darmstadt.de/IPKM/python-tudplot.git + +or use your existing venv. + + + + + +### Installation from source Download the source as [zip file](https://gitea.pkm.physik.tu-darmstadt.de/IPKM/python-tudplot/archive/main.zip) or clone it with git: git clone https://gitea.pkm.physik.tu-darmstadt.de/IPKM/python-tudplot.git Then in the unpacked source directory run: - python3 setup.py install --user + pip install --user --break-system-packages . ## Usage