Add installation instructions

[m_lib.defenc.git] / INSTALL.txt

diff --git a/INSTALL.txt b/INSTALL.txt
new file mode 100644 (file)
index 0000000..4ce4c9e
--- /dev/null
+++ b/INSTALL.txt
@@ -0,0 +1,36 @@
+m_lib.defenc 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 using pip:
+
+    System-wide:
+
+    sudo pip install m_lib.defenc
+
+    User mode:
+
+    pip install --user m_lib.defenc
+
+    Virtual environments:
+
+    pip install user m_lib.defenc
+
+    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
+
+Option '--user' installs m_lib.defenc into
+$HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
+automatically.