[ovs-dev] [PATCH 4/4] docs: Add README.OSX.md

[Dave Tucker]

Signed-off-by: Dave Tucker <dave at dtucker.co.uk>
---
 INSTALL.OSX.md | 43 +++++++++++++++++++++++++++++++++++++++++++
 Makefile.am    |  1 +
 2 files changed, 44 insertions(+)
 create mode 100644 INSTALL.OSX.md

diff --git a/INSTALL.OSX.md b/INSTALL.OSX.md
new file mode 100644
index 0000000..a712391
--- /dev/null
+++ b/INSTALL.OSX.md
@@ -0,0 +1,43 @@
+How to Install Open vSwitch on Mac OSX
+======================================
+
+This document describes how to build and install Open vSwitch on a Apple
+Mac OSX host. Mac OSX support is limited to userspace only at this time.
+
+We have tested this on OSX 10.10 Yosemite
+
+Building Open vSwitch for OSX
+------------------------------
+
+Prerequisties
+-------------
+
+You MUST have the Xcode Command Line utilties installed.
+
+Additionally you should have either Homebrew or MacPorts on your system.
+These instructions assume the former.
+
+Install Autoconf, Automake, Libtool and OpenSSL with the following
+command:
+
+    brew install autoconf automake libtool openssl
+
+Installing
+----------
+
+    ./boot.sh
+    ./configure
+    make && make install
+
+Usage
+-----
+
+> NOTE: Currently the userspace utilities will *only* work with the equivalent OVS version
+
+Assuming you have an Open vSwitch instance listening on `ptcp:6640`, you can interact with it as follows:
+
+    ovs-vsctl --db=tcp:192.168.59.103:6640 show
+    ovs-vsctl --db=tcp:192.168.59.103:6640 add-br br0
+    ovs-vsctl --db=tcp:192.168.59.103:6640 set-manager br0 ptcp:6653
+    
+    ovs-ofctl -OOpenFlow13 dump-flows tcp:192.168.59.103:6653
diff --git a/Makefile.am b/Makefile.am
index b3ff4e3..7d58ef4 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -77,6 +77,7 @@ docs = \
 	INSTALL.KVM.md \
 	INSTALL.Libvirt.md \
 	INSTALL.NetBSD.md \
+	INSTALL.OSX.md \
 	INSTALL.RHEL.md \
 	INSTALL.SSL.md \
 	INSTALL.XenServer.md \
-- 
1.9.3 (Apple Git-50)