Add an up-to-date BUILD.md and modify README.md to reference it

Signed-off-by: Paul Durrant <paul.durrant@citrix.com>

diff --git a/BUILD.md b/BUILD.md
new file mode 100644 (file)
index 0000000..615261a
--- /dev/null
+++ b/BUILD.md
@@ -0,0 +1,59 @@
+Building the XenNet Package
+===========================
+
+First you'll need a device driver build environment for Windows 8, Windows
+8.1, or Windows 10.
+For Windows 8 this means:
+
+*   Visual Studio 2012 (Professional or Ultimate)
+*   Windows Driver Kit 8
+
+For Windows 8.1 this means:
+
+*   Visual Studio 2013 (Any SKU, including Express)
+*   Windows Driver Kit 8.1
+
+For Windows 10 this means:
+
+*   Visual Studio 2015 (Any SKU, including Express or Community)
+*   Windows Driver Kit 10
+
+(See http://msdn.microsoft.com/en-us/windows/hardware/hh852365.aspx). You
+may find it useful to install VirtualCloneDrive from http://www.slysoft.com
+as Visual Studio is generally supplied in ISO form.
+
+Install Visual Studio first (you only need install MFC for C++) and then
+the WDK. Set an environment variable called VS to the base of the Visual
+Studio Installation (e.g. C:\Program Files\Microsoft Visual Studio 12.0) and
+a variable called KIT to the base of the WDK
+(e.g. C:\Program Files\Windows Kits\8.1). Also set an environment variable
+called SYMBOL\_SERVER to point at a location where driver symbols can be
+stored. This can be local directory e.g. C:\Symbols.
+
+NOTE: If you are using WDK 10 then you will need to acquire the DIFx
+      re-distributable package from one of the other WDKs, so that the
+      driver build can copy dpinst.exe into the output.
+      Set the environment variable DPINST_REDIST to the base dpinst
+      directory (i.e. the directory under which the x86 and x64 sub-
+      directories containing dpinst.exe can be found).
+
+Next you'll need a 3.x version of python (which you can get from
+http://www.python.org). Make sure python.exe is somewhere on your default
+path.
+
+Now fire up a Command Prompt and navigate to the base of your git repository.
+At the prompt type:
+
+    build.py checked
+
+This will create a debug build of the driver. To create a non-debug build
+type:
+
+    build.py free
+
+Note that Static Driver Verifier is run by default as part of the build
+process. This can be very time consuming. If you don't want to run the
+verifier then you can add the 'nosdv' keyword to the end of your command
+e.g.:
+
+    build.py free nosdv

diff --git a/README.md b/README.md
index b50a2e6216265862fffc6b84d91be1e7d45b6cf4..2c79b1d282f17dfc6a39f7083a93fa8751b9aa13 100644 (file)
--- a/README.md
+++ b/README.md
@@ -14,37 +14,7 @@ Quick Start Guide
 Building the driver
 -------------------
 
-First you'll need a device driver build environment for Windows 8. For this
-you must use:
-
-*   Visual Studio 2012 (Professional or Ultimate)
-*   Windows Driver Kit 8
-
-(See http://msdn.microsoft.com/en-us/windows/hardware/hh852365.aspx). You
-may find it useful to install VirtualCloneDrive from http://www.slysoft.com
-as Visual Studio is generally supplied in ISO form.
-
-Install Visual Studio first (you only need install MFC for C++) and then
-the WDK. Set an environment variable called VS to the base of the Visual
-Studio Installation (e.g. C:\Program Files\Microsoft Visual Studio 11.0) and
-a variable called KIT to the base of the WDK
-(e.g. C:\Program Files\Windows Kits\8.0). Also set an environment variable
-called SYMBOL\_SERVER to point at a location where driver symbols can be
-stored. This can be local directory e.g. C:\Symbols.
-
-Next you'll need a 3.x version of python (which you can get from
-http://www.python.org). Make sure python.exe is somewhere on your default
-path.
-
-Now fire up a Command Prompt and navigate to the base of your git repository.
-At the prompt type:
-
-    build.py checked
-
-This will create a debug build of the driver. To create a non-debug build
-type:
-
-    build.py free
+See BUILD.md
 
 Installing the driver
 ---------------------