Add release scripts

[m_lib.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
index beed3a4250ad97707d583dcbf7bd9624e0644563..82d9073af0f9f81f615f06cc10dfc081414b96bd 100644 (file)
--- a/INSTALL.txt
+++ b/INSTALL.txt
@@ -3,20 +3,34 @@ 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 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 --user m_lib

 
 

-Installation using pip:
+    Virtual environments:
+
+    pip install 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
+
+    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 --user

 
 

-   pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' [--user] m_lib
+Option '--user' installs m_lib into
+$HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
+automatically.