Update readme to include karaf run description.

Change-Id: Ic3ee9daad40f7c67433fe931757aae10c99f9cfd
Signed-off-by: Sam Hague <shague@redhat.com>

diff --git a/README b/README
index da7159cfb780ea34ffcf6cfde4d6fa80aa3f2a72..b4120cde44c117a362bf9a06ff60f0370dceb5a8 100644 (file)
--- a/README
+++ b/README
@@ -69,8 +69,36 @@ Pre-requisites : JDK 1.7+, Maven 3+
       cd distribution/opendaylight/target/distribution.ovsdb-X.X.X-osgipackage/opendaylight/
       ./run.sh -virt ovsdb
 
-
 2. Building a Karaf Feature and deploying it in an Opendaylight Karaf distribution :
+   1. This is a new method for Opendaylight distribution wherein there is no defined editions such
+      as Base, Virtualization or SP editions. The end-customer can choose to deploy the required feature
+      based on his/her deployment needs.
+
+   2. From the root ovsdb/ directory, execute "mvn clean install"
+
+   3. Next unzip the distribution-karaf-<VERSION_NUMBER>-SNAPSHOT.zip file created from step #2 in
+      the directory ovsdb/distribution/opendaylight-karaf/target like so:
+      "unzip distribution-karaf-<VERSION_NUMBER>-SNAPSHOT.zip"
+
+   4. Once karaf has started and you see the Opendaylight ascii art in the console, the last step
+      is to start the OVSDB plugin framework with the following command in the karaf console:
+      "feature:install odl-ovsdb-openstack" (without quotation marks).
+
+   Sample output from Karaf console :
+
+   opendaylight-user@root>feature:list | grep -i ovsdb
+   odl-ovsdb-all                    | 1.0.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT                  | OpenDaylight :: OVSDB :: all
+   odl-ovsdb-library                | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT                  | OVSDB :: Library
+   odl-ovsdb-schema-openvswitch     | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT                  | OVSDB :: Schema :: Open_vSwitch
+   odl-ovsdb-schema-hardwarevtep    | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT                  | OVSDB :: Schema :: hardware_vtep
+   odl-ovsdb-plugin                 | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT                  | OpenDaylight :: OVSDB :: Plugin
+   odl-ovsdb-northbound             | 0.6.0-SNAPSHOT      |           | ovsdb-1.0.0-SNAPSHOT                  | OpenDaylight :: OVSDB :: Northbound
+   odl-ovsdb-openstack              | 1.0.0-SNAPSHOT      | x         | ovsdb-1.0.0-SNAPSHOT                  | OpenDaylight :: OVSDB :: OpenStack Network Virtual
+   odl-ovsdb-ovssfc                 | 0.0.1-SNAPSHOT      |           | ovsdb-0.0.1-SNAPSHOT                  | OpenDaylight :: OVSDB :: OVS Service Function Chai
+   odl-openflow-nxm-extensions      | 0.0.3-SNAPSHOT      | x         | ovsdb-0.0.3-SNAPSHOT                  | OpenDaylight :: Openflow :: Nicira Extensions
+
+
+3. Building a Karaf Feature and deploying it in an Opendaylight Karaf distribution :
 *** This method is deprecated and an update will be added in the future.
    1. This is a new method for Opendaylight distribution wherein there is no defined editions such
       as Base, Virtualization or SP editions. Rather each of the projects will generate features in