From 766122be7fad43d15da069382731aaee6e636a22 Mon Sep 17 00:00:00 2001
From: rsiddharth <rsd@gnu.org>
Date: Thu, 12 May 2016 21:36:21 +0000
Subject: update README.rst

- all documentation is being moved to docs/
  - installation documentation is at docs/install/index.rst
---
 docs/install/index.rst | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 docs/install/index.rst

(limited to 'docs/install/index.rst')

diff --git a/docs/install/index.rst b/docs/install/index.rst
new file mode 100644
index 0000000..7a4fe0b
--- /dev/null
+++ b/docs/install/index.rst
@@ -0,0 +1,39 @@
+Installation
+------------
+
+On a Debian based distribution, do::
+
+  # aptitude install virtualenv python-setuptools
+
+Install globally
+~~~~~~~~~~~~~~~~
+
+::
+
+   $ sudo pip install lpschedule-generator
+
+
+Install locally using virtualenv (Recommended)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Make a separate ``lpschedule-generator`` directory and initialize the
+virtual environment in it::
+
+  $ mkdir lpschedule-generator
+  $ cd lpschedule-generator
+
+  $ virtualenv .
+  $ source bin/activate
+
+Install ``lpschedule-generator`` inside this directory using ``pip``::
+
+  $ pip install lpschedule-generator
+
+Activating virtual environment
+``````````````````````````````
+
+Always activate the virtual environment before using the ``lps_gen``
+command::
+
+   $ cd path/to/lpschedule-generator
+   $ source bin/activate
-- 
cgit v1.2.3