doc: Update sphinx config and add sima.mpdclient.MPD

[mpd-sima.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 337766ea8a7a65404af0299d6255f19344ee83c8..bdd3f84d9709c68e861c9867d9e5540f0f22b4c0 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,17 +1,24 @@
-Virtualenv installation:
+Designed for python3 >= 3.6
 
-Run ./vinstall.sh to generate the python virtualenv and install requirements.
+Requires: python-musicpd [0],
+          requests [1]
 
-Default looks for python3 on the system.
-It will setup a virtualenv within a "venv" directory (same level as vinstall.sh file).
-It should also write a shell wrapper to run mpd-sima within the virtualenv.
+       [0] https://pypi.org/project/python-musicpd/
+       [1] http://docs.python-requests.org/
 
-       ./vmpd-sima --help
 
-You might specify a python3 interpreter if the binary name differs from python3:
+Virtualenv installation from source:
 
-    PY3=/usr/bin/python ./vinstall.sh
+       Run "python3 ./vinstall.py" from the source to generate the python virtualenv and install
+       requirements.
 
-You can locate the virtalenv somewhere else:
+       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.
 
-    INSTALL_DIR=/tmp/crap_test/ ./vinstall.sh
+               ./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