From f0215c034a81543d1c2923a17ab300f6afd17f0f Mon Sep 17 00:00:00 2001 From: EKNr1 Date: Sat, 1 Feb 2025 12:53:23 +0100 Subject: [PATCH] Improved installation instructions. --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9deb50c..9dcfdc9 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,26 @@ This can be done using: sudo apt install xcb libxcb-cursor0 ffmpeg ``` -Now you can just clone the repo and let pip install it. +Now, you can install Wobuzz using just one more command: + +```bash +pip install wobuzz@git+https://teapot.informationsanarchistik.de/Wobbl/Wobuzz.git#egg=wobuzz +``` + +### Development installation + +If you want to make changes to the code, +you can clone the repo and install it this time using the `-e` parameter, +which will tell pip to not copy the project to `~/.local/lib/python3.x/site-packages`, +but to create symlinks. \ +Using this method, you can put the project wherever you want +(e.g. your Pycharm projects folder) +and the Python-module will always be in sync with the changes you do. ``` bash git clone https://teapot.informationsanarchistik.de/Wobbl/Wobuzz.git cd Wobuzz -pip install . +pip install -e . ``` ## Usage: