Document installation of lftools

Change-Id: I762b8fc6cd82b786c81eb9cc3a0711030a0d1ee5
JIRA: RELENG-325
Signed-off-by: Jeremy Phelps <jphelps@linuxfoundation.org>

diff --git a/docs/index.rst b/docs/index.rst
index 7713dd6..6f1061c 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ Contents:
     :maxdepth: 2
 
     best-practices
+    installation
     commands/index
 
 Indices and tables

diff --git a/docs/installation.rst b/docs/installation.rst
new file mode 100644 (file)
index 0000000..1bf68af
--- /dev/null
+++ b/docs/installation.rst
@@ -0,0 +1,25 @@
+############
+Installation
+############
+
+.. note::
+
+    The Linux Foundation strongly recommends that you have a python
+    virtual environment to work in. https://virtualenv.pypa.io/en/stable/.
+    Not using a virtualenv can have serious negative side effects!
+
+
+For Install
+===========
+
+LFTools is available on pypi.  To install, after making a virtualenv,
+do `pip install lftools` in your shell.
+
+For Development
+===============
+
+Often during development you want to run tests and/or
+try code out locally as you change it.  To do this you
+need the installation of LFTools to be your local git repo.
+After doing `pip install -r requirements.txt` issue the
+command `pip install -e .`