summaryrefslogtreecommitdiff
path: root/windows
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2016-10-30 13:30:04 +0000
committerRussell Bryant <russell@ovn.org>2016-11-03 20:33:53 -0400
commitbbb733c68e6ad8be5f70af73624bca61d8433b57 (patch)
tree3fe9fee80faab49340eb695f4b8dbf209b19f7f6 /windows
parent1e0da13b3127744087f568735aa56542da3f27d1 (diff)
downloadopenvswitch-bbb733c68e6ad8be5f70af73624bca61d8433b57.tar.gz
doc: Update windows/README
This is already in rST (whut?), but we should add a license and make the formatting a little more consistent. Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Russell Bryant <russell@ovn.org>
Diffstat (limited to 'windows')
-rw-r--r--windows/README.rst72
1 files changed, 50 insertions, 22 deletions
diff --git a/windows/README.rst b/windows/README.rst
index 37fb98d5a..bdf063acc 100644
--- a/windows/README.rst
+++ b/windows/README.rst
@@ -1,48 +1,76 @@
-Open vSwitch Windows installer
-==============================
+..
+ Licensed under the Apache License, Version 2.0 (the "License"); you may
+ not use this file except in compliance with the License. You may obtain
+ a copy of the License at
-This project generates a MSI installer for Open vSwitch on Windows, including
-CLI executables, services and the Hyper-V vswitch forwarding extension.
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ License for the specific language governing permissions and limitations
+ under the License.
+
+ Convention for heading levels in Open vSwitch documentation:
+
+ ======= Heading 0 (reserved for the title in a document)
+ ------- Heading 1
+ ~~~~~~~ Heading 2
+ +++++++ Heading 3
+ ''''''' Heading 4
+
+ Avoid deeper levels because they do not render well.
+
+==============
+Windows README
+==============
+
+This directory contains tooling to generate an MSI installer for Open vSwitch
+on Windows, including CLI executables, services and the Hyper-V vswitch
+forwarding extension.
Requirements
------------
-Visual Studio 2013 community, professional, premium or ultimate edition
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* Visual Studio 2013
+
+ Community, Professional, Premium or Ultimate editions can be used.
-Visual Studio Community 2013 is freely available at:
-https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx
+ Visual Studio Community 2013 is freely available from `visualstudio.com
+ <https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx>`__
-WiX Toolset 3.9
-^^^^^^^^^^^^^^^
+* WiX Toolset 3.9
-Download and install from:
-http://wixtoolset.org/releases/v3.9/stable
+ Download and install from `wixtoolset.org
+ <http://wixtoolset.org/releases/v3.9/stable>`__
-Microsoft_VC120_CRT_x86.msm
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* ``Microsoft_VC120_CRT_x86.msm``
-This Windows merge module is available with Visual Studio and contains the
-Visual C++ 2013 x86 runtime redistributables files.
-Copy the file in the *Redist* directory.
+ This Windows merge module is available with Visual Studio and contains the
+ Visual C++ 2013 x86 runtime redistributables files. Copy the file in the
+ ``Redist`` directory.
Open vSwitch installer
----------------------
-The installer will be generated under the following path:
-* windows\ovs-windows-installer\bin\Release\OpenvSwitch.msi
+The installer will be generated under the following path::
-Note: the kernel driver needs to be signed.
+ windows\ovs-windows-installer\bin\Release\OpenvSwitch.msi
+.. note::
-Build instructions
+ The kernel driver needs to be signed.
+
+Build Instructions
------------------
-Build the solution in the Visual Studio IDE or via command line:
+Build the solution in the Visual Studio IDE or via command line::
msbuild ovs-windows-installer.sln /p:Platform=x86 /p:Configuration=Release
Silent installation
-------------------
+::
+
msiexec /i OpenvSwitch.msi ADDLOCAL=OpenvSwitchCLI,OpenvSwitchDriver /l*v log.txt