Release 3.1: the library becomes a namespace package

[m_lib.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
index d04b87fd89421f1a0e2861538570d1d467ab5f98..42fd7fa3ada6726ab545877c4effffe767daf37a 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -1,18 +1,32 @@
-m_lib requires Python2; preferred versions are 2.6 or 2.7.
+m_lib requires Python 2.6, 2.7 or 3.4+.

 
 Installation script setup.py requires setuptools. If you don't have it
 installed setup.py will try to download and install it.
 
 
 Installation script setup.py requires setuptools. If you don't have it
 installed setup.py will try to download and install it.
 

-To install the library from sources system-wide run run the following
-command:
+Installation using pip:

 
 

-   sudo python setup.py install -O2
+    System-wide:

 
 

-If you don't want to install it system-wide you can install it in your
-home directory; run run the following command:
+    sudo pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' m_lib

 
 

-   python setup.py install -O2 --user
+    User mode:

 
 

-Option '--user' only available in Python 2.6 or 2.7. The command
-installs m_lib into $HOME/.local/lib/python2.$VERSION/site-packages/
-where python finds it.
+    pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' --user m_lib
+
+    For Python 2.6 the command is easy_install.
+
+Installation from sources:
+
+    To install the library from sources system-wide run run the following
+    command:
+
+    sudo python setup.py install -O2
+
+    If you don't want to install it system-wide you can install it in your
+    home directory; run run the following command:
+
+    python setup.py install -O2 --user
+
+Option '--user' installs m_lib into
+$HOME/.local/lib/python2.$VERSION/site-packages/ where python finds it
+automatically.