Merge "Updated README to reflect latest changes."

README.rst

@@ -2,8 +2,8 @@
 OpenStack Client
 ================
 
-python-openstackclient is a unified command-line client for the OpenStack APIs.  It is
-a thin wrapper to the stock python-*client modules that implement the
+python-openstackclient is a unified command-line client for the OpenStack APIs.
+It is a thin wrapper to the stock python-*client modules that implement the
 actual REST API client actions.
 
 This is an implementation of the design goals shown in
@@ -12,53 +12,46 @@ a unified shell command structure and a common language to describe
 operations in OpenStack.
 
 python-openstackclient is designed to add support for API extensions via a
-plugin mechanism
+plugin mechanism.
 
-For release management:
+For release management::
 
- * https://launchpad.net/python-openstackclient
+   * https://launchpad.net/python-openstackclient
 
-For blueprints and feature specifications:
+For blueprints and feature specifications::
 
- * https://blueprints.launchpad.net/python-openstackclient
+   * https://blueprints.launchpad.net/python-openstackclient
 
-For issue tracking:
+For issue tracking::
 
- * https://bugs.launchpad.net/python-openstackclient
+   * https://bugs.launchpad.net/python-openstackclient
 
 Getting Started
 ===============
 
 We recommend using a virtualenv to install the client. This description
-uses `virtualenvwrapper`_ to create the virtualenv. Install the prereqs,
-then build the egg, and install the client into the virtualenv::
+uses the `install_venv.py`_ script to create the virtualenv::
 
-    mkvirtualenv openstackclient
-    pip install -r tools/pip-requires
-    python setup.py build
-    easy_install dist/python_openstackclient-0.1-py2.7.egg
+   python tools/install_venv.py
+   source .venv/bin/activate
+   python setup.py develop
 
-.. _virtualenvwrapper: http://www.doughellmann.com/projects/virtualenvwrapper
+Unit tests can be ran simply by running::
 
-If you want to work in development mode, do this instead::
-
-    mkvirtualenv openstackclient
-    pip install -r tools/pip-requires
-    python setup.py develop
-
-Toxicity tests can be ran simply by running ``run_tests.sh``
+   run_tests.sh
 
 The client can be called interactively by simply typing::
+
    openstack
 
 Alternatively command line parameters can be called non-interactively::
-   openstack --help
 
+   openstack --help
 
 Configuration
 =============
 
-The cli is configured via environment variables and command-line
+The CLI is configured via environment variables and command-line
 options as listed in http://wiki.openstack.org/UnifiedCLI/Authentication.
 
 The 'password flow' variation is most commonly used::
@@ -66,8 +59,8 @@ The 'password flow' variation is most commonly used::
    export OS_AUTH_URL=<url-to-openstack-identity>
    export OS_TENANT_NAME=<tenant-name>
    export OS_USERNAME=<user-name>
-   export OS_PASSWORD=<password> # (optional)
-   export OS_USE_KEYRING=true # (optional)
+   export OS_PASSWORD=<password>  # (optional)
+   export OS_USE_KEYRING=true  # (optional)
 
 The corresponding command-line options look very similar::
 
@@ -102,8 +95,8 @@ are listed here::
    --quiet | -q        # suppress output except warnings and errors
    --help | -h         # show a help message and exit
 
-Building Contributor Documentation
-==================================
+Building Documentation
+======================
 
 This documentation is written by contributors, for contributors.
 
@@ -113,15 +106,10 @@ The source is maintained in the ``doc/source`` folder using
 .. _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
-
+Results are in the `build/sphinx/html` directory.