Improved documentation

[mpd-sima.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index f93e22f2d385497543e918d916aa224a26e4bd6e..36b78649a086f1341d8fc0cf4f985a5bc4a14176 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,12 +1,29 @@
+Design for python3 >= 3.2
+
+Requires: python-musicpd >= 0.4.0 [0],
+          requests >= 2.2.0 [1]
+
+       [0] http://media.kaliko.me/src/musicpd/releases/
+       [1] http://docs.python-requests.org/
+
+
 Virtualenv installation:
 
-Run ./vinstall.sh to generate the python virtualenv and install requirements.
-You might specify a python3 interpreter if the binary name defers from python3.3 :
+With python >= 3.3:
+       Run "python3 ./vinstall.py" to generate the python virtualenv and install
+       requirements (need at least python 3.3).
 
-       PY3=/usr/bin/python ./vinstall.sh
+       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.
 
-It should also write a vlaunch sh wrapper to run sima within the virtualenv.
+               ./vmpd-sima --help
 
-       ./vlaunch --help
+For pyton < 3.3 and > 3.1 or if you prefer manual installation:
 
+       # On your system <virtualenv_command> may be "pyenv", "python3 -m venv" or "virtualenv"
+       # Refer to the relevant manual to install a python env, 3.2 minimum.
 
+       <virtualenv_command> ./venv
+       . ./venv/bin/activate
+       ./setup.py install
+       ./venv/bin/mpd-sima --help