From: Oleg Broytman <phd@phdru.name>
Date: Sun, 16 Apr 2017 08:11:39 +0000 (+0300)
Subject: Add installation instructions
X-Git-Tag: 0.0.15~8
X-Git-Url: https://git.phdru.name/?p=m_librarian.git;a=commitdiff_plain;h=d09e36829871616e7837d793806a442d0a6a0aed

Add installation instructions
---

diff --git a/docs/before_begin.rst b/docs/before_begin.rst
index abbb118..e51b2ab 100644
--- a/docs/before_begin.rst
+++ b/docs/before_begin.rst
@@ -14,7 +14,8 @@ Software
 --------
 
 m_Librarian is written in Python and requires Python 2.7. So install
-Python 2.7 first. Install required modules: SQLObject and m_lib.
+Python 2.7 first. Install required modules: SQLObject and m_lib. pip
+`installs <install.html>`_ required modules automatically.
 
 
 Library archives
diff --git a/docs/index.rst b/docs/index.rst
index 90efc01..8b4bf9f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,9 +16,10 @@ Contents:
 .. toctree::
    :maxdepth: 2
 
-   news
    before_begin
+   install
    command_line
+   news
 
 
 Indices and tables
diff --git a/docs/install.rst b/docs/install.rst
new file mode 100644
index 0000000..93151ce
--- /dev/null
+++ b/docs/install.rst
@@ -0,0 +1,41 @@
+Installation using pip
+======================
+
+System-wide
+-----------
+
+::
+
+    sudo pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' m_librarian
+
+User mode
+---------
+
+::
+
+    pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' --user m_librarian
+
+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_librarian into
+$HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
+automatically. It also installs m_librarian scripts into $HOME/.local/bin;
+add the directory to your $PATH or move the scripts to a directory in your
+$PATH.