From 25051a733da7dbcaf8a06d3bc8c3b2397e178494 Mon Sep 17 00:00:00 2001
From: Matt Joyce <matt.joyce@cloudscaling.com>
Date: Mon, 14 May 2012 17:01:46 -0700
Subject: Updating Readme Document

Change-Id: I0c0f5c86b0bfa96ab4d7236eb2e7e7efab6fbac0
---
 README.rst | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 54 insertions(+), 1 deletion(-)

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
index 8ac6ce5f..3a789ec0 100644
--- a/README.rst
+++ b/README.rst
@@ -14,6 +14,35 @@ operations in OpenStack.
 python-openstackclient is designed to add support for API extensions via a
 plugin mechanism
 
+For release management:
+
+ * https://launchpad.net/python-openstackclient
+
+For blueprints and feature specifications:
+
+ * https://blueprints.launchpad.net/python-openstackclient
+
+For issue tracking:
+
+ * https://bugs.launchpad.net/python-openstackclient
+
+Getting Started
+===============
+
+Once you have downloaded the client it can be built from setup.py with::
+   python setup.py install
+
+Alternatively you can build without installing with::
+   python setup.py build
+
+Toxicity tests can be ran simply by running ``run_tests.sh``
+
+The client can be called interactively by simply typing::
+   openstack
+
+Alternatively command line parameters can be called non-interactively::
+   openstack --help
+
 
 Configuration
 =============
@@ -54,4 +83,28 @@ are listed here::
                          (via httplib2)
    --verbose | -v      # Increase verbosity of output. Can be repeated.
    --quiet | -q        # suppress output except warnings and errors
-   --help | -h         # show a help message and exit
\ No newline at end of file
+   --help | -h         # show a help message and exit
+
+Building Contributor Documentation
+==================================
+
+This documentation is written by contributors, for contributors.
+
+The source is maintained in the ``docs/source`` folder using
+`reStructuredText`_ and built by `Sphinx`_
+
+.. _reStructuredText: http://docutils.sourceforge.net/rst.html
+.. _Sphinx: http://sphinx.pocoo.org/
+
+* Building Automatically::
+
+    $ ./run_tests.sh --docs
+
+* Building Manually::
+
+    $ export DJANGO_SETTINGS_MODULE=local.local_settings
+    $ python doc/generate_autodoc_index.py
+    $ sphinx-build -b html doc/source build/sphinx/html
+
+Results are in the `build/sphinx/html` directory
+
-- 
cgit v1.2.1