aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSimon Rozman <simon@rozman.si>2019-04-19 15:24:39 +0200
committerSimon Rozman <simon@rozman.si>2019-04-19 15:25:44 +0200
commit9f31f278400570d949b85350290753cdeea30a9c (patch)
tree043e6aa1cdb99d7ad9558669238b44a296e111d0 /README.md
parentMakefile: use more standard output filenames for msm (diff)
downloadwintun-9f31f278400570d949b85350290753cdeea30a9c.tar.xz
wintun-9f31f278400570d949b85350290753cdeea30a9c.zip
Switch from NMake to MSBuild
This allows common version and other configuration in wintun.props. - MSM packaging migrated to WiX MSBuild project and extended to support digital signing - Building supports single Platform|Configuration per run - again :( - wintun.vcxproj cleanup Signed-off-by: Simon Rozman <simon@rozman.si>
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 17 insertions, 5 deletions
diff --git a/README.md b/README.md
index 2db1beb..34ef9ab 100644
--- a/README.md
+++ b/README.md
@@ -37,18 +37,22 @@ If you already have `wintun.vcxproj.user` file, just add the `<PropertyGroup>` s
Open _Developer Command Prompt for VS 2017_ and use the `nmake` command:
```
-nmake [<target>]
+msbuild wintun.proj [/t:<target>] [/p:Configuration=<configuration>] [/p:Platform=<platform>]
```
### Targets
- - `build`: Builds the driver. This is the default target.
+ - `Build`: Builds the driver. This is the default target.
- - `clean`: Deletes all intermediate and output files.
+ - `Clean`: Deletes all intermediate and output files.
- - `dvl`: Runs Static Driver Verifier, which includes a clean driver build, and creates a Driver Verification Log in `wintun.DVL.XML` file. When you are ready to test your driver using the Windows Hardware Certification Kit (HCK), you need to copy the `wintun.DVL.XML` file to the `%SystemDrive%\DVL` directory on the test computer.
+ - `Rebuild`: Alias for `Clean` followed by `Build`.
- - `msm`: Builds Microsoft Installer Merge Module in `<output folder>\wintun.msm`. This target requires the driver to be built first (e.g. `nmake build msm` or `nmake dvl msm`).
+ - `SDV`: Runs Static Driver Verifier, which includes a clean driver build. Release configurations only.
+
+ - `DVL`: Runs the `SDV`, and creates a Driver Verification Log in `wintun.DVL.XML` file. Release configurations only. When you are ready to test your driver using the Windows Hardware Certification Kit (HCK), you need to copy the `wintun.DVL.XML` file to the `%SystemDrive%\DVL` directory on the test computer.
+
+ - `MSM`: Builds Microsoft Installer Merge Module in `<output folder>\wintun-<platform>-<version>.msm`.
The driver output folder is:
@@ -61,6 +65,14 @@ AMD64 Release | `amd64\Release\wintun`
ARM64 Debug | `arm64\Debug\wintun`
ARM64 Release | `arm64\Release\wintun`
+### Properties
+
+Properties may be defined as environment variables, or specified on the `msbuild` command line.
+
+ - `Configuration`: Specifies configuration to build or clean. May be `Debug` or `Release` (default).
+
+ - `Platform`: Specifies driver platform to build. May be `x86` or `amd64` (default), or `arm64`.
+
## Usage