Add generic installation instructions
authorOleg Broytman <phd@phdru.name>
Sun, 16 Apr 2017 08:42:15 +0000 (11:42 +0300)
committerOleg Broytman <phd@phdru.name>
Sun, 16 Apr 2017 08:42:15 +0000 (11:42 +0300)
cookiecutter
project_template/docs/install.rst [new file with mode: 0644]

index 52ea377..539fdda 100755 (executable)
@@ -15,7 +15,7 @@ cd "$HOME/tmp/$project_name" &&
 mv project "$project_name" &&
 
 replace '{project}' "$project_name" .gitignore README.txt \
-   docs/genapidocs mk-distr publish-docs setup.py tox.ini &&
+   docs/genapidocs docs/install.rst mk-distr publish-docs setup.py tox.ini &&
 
 sphinx-quickstart --project="$project_name" --author="Oleg Broytman" \
    -v0.0 -r0.0.1 --ext-autodoc --makefile --no-batchfile -q docs &&
diff --git a/project_template/docs/install.rst b/project_template/docs/install.rst
new file mode 100644 (file)
index 0000000..a7f6197
--- /dev/null
@@ -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.