X-Git-Url: https://git.phdru.name/?p=cookiecutter.git;a=blobdiff_plain;f=project_template%2Fdocs%2Finstall.rst;fp=project_template%2Fdocs%2Finstall.rst;h=a7f6197c433187715b066dc17ee164671c7b6f45;hp=0000000000000000000000000000000000000000;hb=13450f371aa445a050f7735d060d301abb340dc6;hpb=f9dda9d355a3d7e4c76d3ab94b38c8aeeebf99d1

diff --git a/project_template/docs/install.rst b/project_template/docs/install.rst
new file mode 100644
index 0000000..a7f6197
--- /dev/null
+++ b/project_template/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' {project}
+
+User mode
+---------
+
+::
+
+    pip install --find-links=http://phdru.name/Software/Python/ --no-index --install-option='-O2' --user {project}
+
+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 {project} into
+$HOME/.local/lib/python$MAJOR.$MINOR/site-packages/ where python finds it
+automatically. It also installs {project} scripts into $HOME/.local/bin;
+add the directory to your $PATH or move the scripts to a directory in your
+$PATH.