Cleanup plugin class

[mpd-sima.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 28aef94b66f45f689eb535ec166e6a88b17b3b1d..bdd3f84d9709c68e861c9867d9e5540f0f22b4c0 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,8 +1,24 @@
-Virtualenv installation:
+Designed for python3 >= 3.6
 
-run ./vinstall.sh to generate the pyton virtualenv and install requirements.
-It should also write a vlaunch sh wrapper to run sima whithin the virtualenv.
+Requires: python-musicpd [0],
+          requests [1]
 
-       ./vlaunch --help
+       [0] https://pypi.org/project/python-musicpd/
+       [1] http://docs.python-requests.org/
 
 
+Virtualenv installation from source:
+
+       Run "python3 ./vinstall.py" from the source to generate the python virtualenv and install
+       requirements.
+
+       It will setup a virtualenv within a "venv" directory (same level as vinstall.py file).
+       It should also write a shell wrapper to run mpd-sima within the virtualenv.
+
+               ./vmpd-sima --help
+
+Virtualenv installation with pip:
+
+       python3 -m venv mpd-sima
+       ./mpd-sima/bin/pip install MPD-sima
+       ./mpd-sima/bin/mpd-sima --help