summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Graf <tgraf@noironetworks.com>2014-10-28 11:19:52 +0100
committerBen Pfaff <blp@nicira.com>2014-10-28 08:55:18 -0700
commit542cc9bb8b8817866afcd692a78fa591db5839dc (patch)
treeb41df76180142279ae927a95df791f6384fad247 /README.md
parent3aa40c8301b3c2538c18569e2a1e05d500b53392 (diff)
downloadopenvswitch-542cc9bb8b8817866afcd692a78fa591db5839dc.tar.gz
doc: Convert docs to Markdown language
Converts the majority of docs over to use the Markdown language for pretty printing on GitHub. It's a rough first convertion without exploiting the full potential of Markdown at this point. Section titles and indentation are fixed as needed. Minimal docs interlinking is added. Signed-off-by: Thomas Graf <tgraf@noironetworks.com> Signed-off-by: Ben Pfaff <blp@nicira.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.md b/README.md
index 538613062..5084c310d 100644
--- a/README.md
+++ b/README.md
@@ -81,24 +81,27 @@ 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
+- [INSTALL.Debian](INSTALL.Debian.md)
+- [INSTALL.Fedora](INSTALL.Fedora.md)
+- [INSTALL.RHEL](INSTALL.RHEL.md)
+- [INSTALL.XenServer](INSTALL.XenServer.md)
To use Open vSwitch...
-- ...with Docker on Linux, read INSTALL.Docker.
+- ...with Docker on Linux, read [INSTALL.Docker](INSTALL.Docker.md)
-- ...with KVM on Linux, read INSTALL, read INSTALL.KVM.
+- ...with KVM on Linux, read [INSTALL](INSTALL.md), read
+ [INSTALL.KVM](INSTALL.KVM.md)
-- ...with Libvirt, read INSTALL.Libvirt.
+- ...with Libvirt, read [INSTALL.Libvirt](INSTALL.Libvirt.md).
-- ...without using a kernel module, read INSTALL.userspace.
+- ...without using a kernel module, read
+[INSTALL.userspace](INSTALL.userspace.md).
For answers to common questions, read FAQ.
-To learn how to set up SSL support for Open vSwitch, read INSTALL.SSL.
+To learn how to set up SSL support for Open vSwitch, read
+[INSTALL.SSL](INSTALL.SSL.md).
To learn about some advanced features of the Open vSwitch software
switch, read the tutorial in tutorial/Tutorial.