From 0f884f437eb56d24ac1a62df2ed9d45c290e19f7 Mon Sep 17 00:00:00 2001
From: Kashyap Kopparam <kashyapk@thoughtworks.com>
Date: Wed, 5 Nov 2014 11:39:36 +0530
Subject: [PATCH] Kashyap | prettified readme

---
 README.md | 50 ++++++++++++++++++++------------------------------
 1 file changed, 20 insertions(+), 30 deletions(-)

diff --git a/README.md b/README.md
index 1a681a9..cdd9ccb 100644
--- a/README.md
+++ b/README.md
@@ -18,9 +18,9 @@ as a hypervisor while continuing to be able to manage the existing private cloud
 
 ## Quick Setup Steps
 
-1. Go to <OpenStack Root Dir>/nova/nova/virt/
-2. `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
-3. Go to /etc/nova/nova.conf and make sure it contains the following, you might have the default and conductor section already, but add the ec2driver section:-
+1. `$ cd <openstack_root_dir>/nova/nova/virt/`
+2. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
+3. `$ vim /etc/nova/nova.conf # make sure it contains the following options in the respective sections`
 
         [DEFAULT]
         compute_driver=ec2.EC2Driver
@@ -31,29 +31,21 @@ as a hypervisor while continuing to be able to manage the existing private cloud
         [ec2driver]
         ec2_secret_access_key = <your_aws_secret_access_key>
         ec2_access_key_id = <your_aws_access_key_id>
-4. Now go to the ec2 directory that was cloned and edit the ec2driver_standard_config.py if required.
-5. Restart the nova compute service. 
+4. `ec2driver_standard_config.py` can be edited to configure the default AMI, AWS region and endpoints. 
+5. Restart the nova-compute service. You are now all set cloud burst!
 
-You are now all set cloud burst!
-
-## What's supported!
-Launch
-Reboot
-Terminate
-Resize
-Pause/Unpause*
-Suspend/Resume*
-Attach/Detach Volume
-Snapshot
+### What's supported!
+Launch, Reboot, Terminate, Resize, Pause/Unpause*, Suspend/Resume*, Attach/Detach Volume, Snapshot
 
 #For Contributors
 
 ###Instructions for Developer Environment setup
-1. Install git, Virtualbox and Vagrant and Clone this repository: `git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git`
-2. Run`vagrant up` from within the repository to create an Ubuntu virtualbox that will install devstack. This will take a couple minutes.
-3. `vagrant ssh` to ssh into the new machine
-4. Refer to Step 3 in Quick Setup to edit nova.conf
-5. Restart nova
+1. Install git, Virtualbox and Vagrant.
+2. `$ git clone https://github.com/ThoughtWorksInc/OpenStack-EC2-Driver.git ec2`
+3. `$ cd ec2/ && vagrant up` This will download the development environment from Vagrant clound and setup devstack. 
+4. `$ vagrant ssh`
+5. Edit nova.conf and add the ec2 configuration options, refer to step 3 in Quick setup guide.
+6. Restart nova-compute
   - `~/devstack/rejoin-stack.sh`
   - go to the nova-cpu screen (`ctrl+a`, `7`)
   - restart the process with `ctrl+c`, press up, and then enter
@@ -62,13 +54,11 @@ Snapshot
 The driver should now be loaded. The contents of the repository is mapped to `/opt/stack/nova/nova/virt/ec2/`, and you can edit it directly from your host computer with an IDE of your choice.
 
 ###Running Tests
-1. Moto can be used to mock the EC2 server. To install moto, run `pip install moto`.
-1. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`.
-2. `~/devstack/rejoin-stack.sh`
-3. `cd /opt/stack/nova/nova/virt/ec2/tests`
-4. Use `nosetests -s test_ec2driver.py`
-5. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`.
-
-
-* In Amazon’s EC2 there is no concept of suspend and resume on instances. Therefore, we simply stop EC2 instances when suspended and start the instances when resumed, we do the same on pause and un-pause.
+1. Moto can be used to mock the EC2 server. To install moto, run `sudo pip install moto`.
+2. To optionally use Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/setup_moto.sh`.
+3. `~/devstack/rejoin-stack.sh`
+4. `cd /opt/stack/nova/nova/virt/ec2/tests`
+5. Use `nosetests -s test_ec2driver.py`
+6. To stop Moto, run `source /opt/stack/nova/nova/virt/ec2/tests/shutdown_moto.sh`.
 
+\* In Amazon’s EC2 there is no concept of suspend and resume on instances. Therefore, we simply stop EC2 instances when suspended and start the instances when resumed, we do the same on pause and un-pause.
\ No newline at end of file