2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00

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>
This commit is contained in:
Stephen Finucane 2016-10-30 13:30:04 +00:00 committed by Russell Bryant
parent 1e0da13b31
commit bbb733c68e

View File

@ -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
Visual Studio Community 2013 is freely available at:
https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx
Community, Professional, Premium or Ultimate editions can be used.
WiX Toolset 3.9
^^^^^^^^^^^^^^^
Visual Studio Community 2013 is freely available from `visualstudio.com
<https://www.visualstudio.com/en-us/products/visual-studio-community-vs.aspx>`__
Download and install from:
http://wixtoolset.org/releases/v3.9/stable
* WiX Toolset 3.9
Microsoft_VC120_CRT_x86.msm
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Download and install from `wixtoolset.org
<http://wixtoolset.org/releases/v3.9/stable>`__
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.
* ``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.
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