From 757c18c7fb6524e0cf5213127a2acb8761ea9631 Mon Sep 17 00:00:00 2001
From: Pierre RAMBAUD <pierre.rambaud@numergy.com>
Date: Mon, 3 Mar 2014 14:34:17 +0100
Subject: Improve readme.rst

This file must be readable and have sections to separate usage
from tests.
Path for using trove in integration are wrong, the directory
bin does not exists.

Change-Id: I75dcf229580ead055233f8d7f7ea4acc07baadcf
Closes-Bug: #1287186
---
 README.rst | 50 ++++++++++++++++++++++++++++++++++++++------------
 1 file changed, 38 insertions(+), 12 deletions(-)

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
index d67b34f4..2f46f246 100644
--- a/README.rst
+++ b/README.rst
@@ -4,22 +4,48 @@ Trove
 Trove is Database as a Service for Open Stack.
 
 
+=============================
+Usage for integration testing
+=============================
+If you'd like to start up a fake Trove API daemon for integration testing
+with your own tool, run:
+
+.. code-block:: bash
+
+    $ ./tools/start-fake-mode.sh
+
+Stop the server with:
+
+.. code-block:: bash
+
+    $ ./tools/stop-fake-mode.sh
+
+
+======
+Tests
+======
 To run all tests and PEP8, run tox, like so:
-$ tox
 
-To quickly run the tests for Python 2.7, run:
-$ tox -epy27
+.. code-block:: bash
+
+    $ tox
 
-To quickly run PEP8, run:
-$ tox -epep8
+To run just the tests for Python 2.7, run:
+
+.. code-block:: bash
+
+    $ tox -epy27
+
+To run just PEP8, run:
+
+.. code-block:: bash
+
+    $ tox -epep8
 
 To generate a coverage report,run:
-$ tox -ecover
-(note: on some boxes, the results may not be accurate unless you run it twice)
 
-If you'd like to start up a fake Trove API daemon for integration testing
-with your own tool, run:
-$ ./bin/start_server
+.. code-block:: bash
 
-Stop the server with:
-$ ./bin/stop_server
+    $ tox -ecover
+
+(note: on some boxes, the results may not be accurate unless you run it twice)
-- 
cgit v1.2.1