Improved installation instructions.
This commit is contained in:
parent
1fefc76dd7
commit
f0215c034a
1 changed files with 16 additions and 2 deletions
18
README.md
18
README.md
|
@ -19,12 +19,26 @@ This can be done using:
|
||||||
sudo apt install xcb libxcb-cursor0 ffmpeg
|
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
|
``` bash
|
||||||
git clone https://teapot.informationsanarchistik.de/Wobbl/Wobuzz.git
|
git clone https://teapot.informationsanarchistik.de/Wobbl/Wobuzz.git
|
||||||
cd Wobuzz
|
cd Wobuzz
|
||||||
pip install .
|
pip install -e .
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage:
|
## Usage:
|
||||||
|
|
Loading…
Add table
Reference in a new issue