README: Adding github markup and travis-ci build status to github readme page.

Signed-off-by: Pritesh Kothari <pritesh.kothari@cisco.com>
Signed-off-by: Ben Pfaff <blp@nicira.com>

diff --git a/INSTALL b/INSTALL
index 7f670dd..3cfdc04 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -51,7 +51,7 @@ at some cost in features and performance (see INSTALL.userspace for
 details).  To compile the kernel module on Linux, you must also
 install the following:
 
-    - A supported Linux kernel version.  Please refer to README for a
+    - A supported Linux kernel version.  Please refer to README.md for a
       list of supported versions.
 
       The Open vSwitch datapath requires bridging support

diff --git a/Makefile.am b/Makefile.am
index 56dada7..77ceec6 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -82,6 +82,7 @@ EXTRA_DIST = \
        NOTICE \
        OPENFLOW-1.1+ \
        PORTING \
+       README.md \
        README-lisp \
        REPORTING-BUGS \
        TODO \

diff --git a/README b/README
deleted file mode 100644 (file)
index c87357d..0000000
--- a/README
+++ /dev/null
@@ -1,116 +0,0 @@
-                 Open vSwitch <http://openvswitch.org>
-
-What is Open vSwitch?
----------------------
-
-Open vSwitch is a multilayer software switch licensed under the open
-source Apache 2 license.  Our goal is to implement a production
-quality switch platform that supports standard management interfaces
-and opens the forwarding functions to programmatic extension and
-control.
-
-Open vSwitch is well suited to function as a virtual switch in VM
-environments.  In addition to exposing standard control and visibility
-interfaces to the virtual networking layer, it was designed to support
-distribution across multiple physical servers.  Open vSwitch supports
-multiple Linux-based virtualization technologies including
-Xen/XenServer, KVM, and VirtualBox.
-
-The bulk of the code is written in platform-independent C and is
-easily ported to other environments.  The current release of Open
-vSwitch supports the following features:
-
-    * Standard 802.1Q VLAN model with trunk and access ports
-    * NIC bonding with or without LACP on upstream switch
-    * NetFlow, sFlow(R), and mirroring for increased visibility
-    * QoS (Quality of Service) configuration, plus policing
-    * Geneve, GRE, GRE over IPSEC, VXLAN, and LISP tunneling
-    * 802.1ag connectivity fault management
-    * OpenFlow 1.0 plus numerous extensions
-    * Transactional configuration database with C and Python bindings
-    * High-performance forwarding using a Linux kernel module
-
-The included Linux kernel module supports Linux 2.6.32 and up, with
-testing focused on 2.6.32 with Centos and Xen patches.  Open vSwitch
-also has special support for Citrix XenServer and Red Hat Enterprise
-Linux hosts.
-
-Open vSwitch can also operate, at a cost in performance, entirely in
-userspace, without assistance from a kernel module.  This userspace
-implementation should be easier to port than the kernel-based switch.
-It is considered experimental.
-
-What's here?
-------------
-
-The main components of this distribution are:
-
-    * ovs-vswitchd, a daemon that implements the switch, along with 
-      a companion Linux kernel module for flow-based switching.
-
-    * ovsdb-server, a lightweight database server that ovs-vswitchd
-      queries to obtain its configuration.
-
-    * ovs-dpctl, a tool for configuring the switch kernel module.
-
-    * Scripts and specs for building RPMs for Citrix XenServer and Red
-      Hat Enterprise Linux.  The XenServer RPMs allow Open vSwitch to
-      be installed on a Citrix XenServer host as a drop-in replacement
-      for its switch, with additional functionality.
-
-    * ovs-vsctl, a utility for querying and updating the configuration
-      of ovs-vswitchd.
-
-    * ovs-appctl, a utility that sends commands to running Open
-      vSwitch daemons.
-
-Open vSwitch also provides some tools:
-
-    * ovs-ofctl, a utility for querying and controlling OpenFlow
-      switches and controllers.
-
-    * ovs-pki, a utility for creating and managing the public-key
-      infrastructure for OpenFlow switches.
-
-    * ovs-testcontroller, a simple OpenFlow controller that may be useful
-      for testing (though not for production).
-
-    * A patch to tcpdump that enables it to parse OpenFlow messages.
-
-What other documentation is available?
---------------------------------------
-
-To install Open vSwitch on a regular Linux or FreeBSD host, please
-read INSTALL.  For specifics around installation on a specific
-platform, please see one of these files:
-
-    - INSTALL.Debian
-    - INSTALL.Fedora
-    - INSTALL.RHEL
-    - INSTALL.XenServer
-
-To use Open vSwitch...
-
-    - ...with KVM on Linux, read INSTALL, read INSTALL.KVM.
-
-    - ...with Libvirt, read INSTALL.Libvirt.
-
-    - ...without using a kernel module, read INSTALL.userspace.
-
-For answers to common questions, read FAQ.
-
-To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.
-
-To learn about some advanced features of the Open vSwitch software
-switch, read the tutorial in tutorial/Tutorial.
-
-Each Open vSwitch userspace program is accompanied by a manpage.  Many
-of the manpages are customized to your configuration as part of the
-build process, so we recommend building Open vSwitch before reading
-the manpages.
-
-Contact 
--------
-
-bugs@openvswitch.org
-http://openvswitch.org/

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e4bc75a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,112 @@
+# Open vSwitch
+
+Build Status:
+-------------
+
+[![Build Status](https://travis-ci.org/openvswitch/ovs.png)](https://travis-ci.org/openvswitch/ovs)
+
+What is Open vSwitch?
+---------------------
+
+Open vSwitch is a multilayer software switch licensed under the open
+source Apache 2 license.  Our goal is to implement a production
+quality switch platform that supports standard management interfaces
+and opens the forwarding functions to programmatic extension and
+control.
+
+Open vSwitch is well suited to function as a virtual switch in VM
+environments.  In addition to exposing standard control and visibility
+interfaces to the virtual networking layer, it was designed to support
+distribution across multiple physical servers.  Open vSwitch supports
+multiple Linux-based virtualization technologies including
+Xen/XenServer, KVM, and VirtualBox.
+
+The bulk of the code is written in platform-independent C and is
+easily ported to other environments.  The current release of Open
+vSwitch supports the following features:
+
+* Standard 802.1Q VLAN model with trunk and access ports
+* NIC bonding with or without LACP on upstream switch
+* NetFlow, sFlow(R), and mirroring for increased visibility
+* QoS (Quality of Service) configuration, plus policing
+* Geneve, GRE, GRE over IPSEC, VXLAN, and LISP tunneling
+* 802.1ag connectivity fault management
+* OpenFlow 1.0 plus numerous extensions
+* Transactional configuration database with C and Python bindings
+* High-performance forwarding using a Linux kernel module
+
+The included Linux kernel module supports Linux 2.6.32 and up, with
+testing focused on 2.6.32 with Centos and Xen patches.  Open vSwitch
+also has special support for Citrix XenServer and Red Hat Enterprise
+Linux hosts.
+
+Open vSwitch can also operate, at a cost in performance, entirely in
+userspace, without assistance from a kernel module.  This userspace
+implementation should be easier to port than the kernel-based switch.
+It is considered experimental.
+
+What's here?
+------------
+
+The main components of this distribution are:
+
+* ovs-vswitchd, a daemon that implements the switch, along with
+  a companion Linux kernel module for flow-based switching.
+* ovsdb-server, a lightweight database server that ovs-vswitchd
+  queries to obtain its configuration.
+* ovs-dpctl, a tool for configuring the switch kernel module.
+* Scripts and specs for building RPMs for Citrix XenServer and Red
+  Hat Enterprise Linux.  The XenServer RPMs allow Open vSwitch to
+  be installed on a Citrix XenServer host as a drop-in replacement
+  for its switch, with additional functionality.
+* ovs-vsctl, a utility for querying and updating the configuration
+  of ovs-vswitchd.
+* ovs-appctl, a utility that sends commands to running Open
+      vSwitch daemons.
+
+Open vSwitch also provides some tools:
+
+* ovs-ofctl, a utility for querying and controlling OpenFlow
+  switches and controllers.
+* ovs-pki, a utility for creating and managing the public-key
+  infrastructure for OpenFlow switches.
+* ovs-testcontroller, a simple OpenFlow controller that may be useful
+  for testing (though not for production).
+* A patch to tcpdump that enables it to parse OpenFlow messages.
+
+What other documentation is available?
+--------------------------------------
+
+To install Open vSwitch on a regular Linux or FreeBSD host, please
+read INSTALL.  For specifics around installation on a specific
+platform, please see one of these files:
+
+- INSTALL.Debian
+- INSTALL.Fedora
+- INSTALL.RHEL
+- INSTALL.XenServer
+
+To use Open vSwitch...
+
+- ...with KVM on Linux, read INSTALL, read INSTALL.KVM.
+
+- ...with Libvirt, read INSTALL.Libvirt.
+
+- ...without using a kernel module, read INSTALL.userspace.
+
+For answers to common questions, read FAQ.
+
+To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.
+
+To learn about some advanced features of the Open vSwitch software
+switch, read the tutorial in tutorial/Tutorial.
+
+Each Open vSwitch userspace program is accompanied by a manpage.  Many
+of the manpages are customized to your configuration as part of the
+build process, so we recommend building Open vSwitch before reading
+the manpages.
+
+Contact
+-------
+
+bugs@openvswitch.org

diff --git a/rhel/openvswitch-fedora.spec.in b/rhel/openvswitch-fedora.spec.in
index 0efebd4..c5e99ef 100644 (file)
--- a/rhel/openvswitch-fedora.spec.in
+++ b/rhel/openvswitch-fedora.spec.in
@@ -203,7 +203,7 @@ systemctl start openvswitch.service
 %doc /usr/share/man/man8/ovs-test.8.gz
 %doc /usr/share/man/man8/ovs-l3ping.8.gz
 %doc /usr/share/man/man8/vtep-ctl.8.gz
-%doc COPYING DESIGN INSTALL.SSL NOTICE README WHY-OVS FAQ NEWS INSTALL.DPDK
+%doc COPYING DESIGN INSTALL.SSL NOTICE README.md WHY-OVS FAQ NEWS INSTALL.DPDK
 /var/lib/openvswitch
 /var/log/openvswitch
 /usr/share/openvswitch/scripts/ovs-ctl

diff --git a/rhel/openvswitch.spec.in b/rhel/openvswitch.spec.in
index 88bc673..56b7404 100644 (file)
--- a/rhel/openvswitch.spec.in
+++ b/rhel/openvswitch.spec.in
@@ -174,7 +174,7 @@ exit 0
 /usr/share/openvswitch/scripts/sysconfig.template
 /usr/share/openvswitch/vswitch.ovsschema
 /usr/share/openvswitch/vtep.ovsschema
-%doc COPYING DESIGN INSTALL.SSL NOTICE README WHY-OVS FAQ NEWS
+%doc COPYING DESIGN INSTALL.SSL NOTICE README.md WHY-OVS FAQ NEWS
 %doc INSTALL.DPDK rhel/README.RHEL
 /var/lib/openvswitch
 /var/log/openvswitch

diff --git a/utilities/ovs-ctl.8 b/utilities/ovs-ctl.8
index 2925274..0f70403 100644 (file)
--- a/utilities/ovs-ctl.8
+++ b/utilities/ovs-ctl.8
@@ -441,5 +441,5 @@ distribution are good examples of how to use \fBovs\-ctl\fR.
 .
 .SH "SEE ALSO"
 .
-\fBREADME\fR, \fBINSTALL.Linux\fR, \fBovsdb\-server\fR(8),
+\fBREADME.md\fR, \fBINSTALL.Linux\fR, \fBovsdb\-server\fR(8),
 \fBovs\-vswitchd\fR(8).