From 753a04c9d7475ed2d97360692b89f3a5d1bf4280 Mon Sep 17 00:00:00 2001 From: Sharat Sharma Date: Tue, 25 Jul 2017 18:17:12 +0530 Subject: [PATCH] Make README better There are few places like https://github.com/openstack/python-mistralclient#running-mistral-client in the README where the commands in the block are clumpsy. This patch makes the commands look better. Change-Id: I1caa538b7f182dc1e1afcd1ace285b1d16de299c --- README.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 36178c9b..dcaef5f7 100644 --- a/README.rst +++ b/README.rst @@ -37,16 +37,16 @@ Command Line Interface (CLI) library. Installation ------------ -First of all, clone the repo and go to the repo directory: +First of all, clone the repo and go to the repo directory:: $ git clone git://git.openstack.org/openstack/python-mistralclient.git $ cd python-mistralclient -Then just run: +Then just run:: $ pip install -e . -or +or:: $ pip install -r requirements.txt $ python setup.py install @@ -56,7 +56,7 @@ Running Mistral client ---------------------- If Mistral authentication is enabled, provide the information about OpenStack -auth to environment variables. Type: +auth to environment variables. Type:: $ export OS_AUTH_URL=http://:5000/v2.0 $ export OS_USERNAME=admin @@ -72,11 +72,11 @@ and in the case that you are authenticating against keystone over https: .. note:: In client, we can use both Keystone auth versions - v2.0 and v3. But server supports only v3.* -To make sure Mistral client works, type: +To make sure Mistral client works, type:: $ mistral workbook-list -You can see the list of available commands typing: +You can see the list of available commands typing:: $ mistral --help