Hesham/wintun
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixup readme markdown formatting

Browse Source 
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
This commit is contained in:
Jason A. Donenfeld 2019-04-14 08:48:00 +02:00
parent 6298787aa3
commit 82655e6e0e
1 changed files with 13 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -33,7 +33,7 @@ If you already have `wintun.vcxproj.user` file, just add the `<PropertyGroup>` s
## Building from Command Line
Open _Developer Command Prompt for VS 2017_ and use `nmake` command:
Open _Developer Command Prompt for VS 2017_ and use the `nmake` command:
```
nmake [<target>] [CFG=<configuration>] [PLAT=<platform>]
@ -41,32 +41,28 @@ nmake [<target>] [CFG=<configuration>] [PLAT=<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. 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.
- `dvl`: Runs Static Driver Verifier, which includes a clean driver build, 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.
The driver output folder is:
| Platform and Configuration | Folder |
| -------------------------- | -------------------- |
| x86 Debug | `Debug\wintun` |
| x86 Release | `Release\wintun` |
| AMD64 Debug | `x64\Debug\wintun` |
| AMD64 Release | `x64\Release\wintun` |
Platform and Configuration | Folder
-------------------------- | --------------------
x86 Debug | `Debug\wintun`
x86 Release | `Release\wintun`
AMD64 Debug | `x64\Debug\wintun`
AMD64 Release | `x64\Release\wintun`
### Properties
Properties may be defined as environment variables, or specified on the `nmake` command line.
`CFG`
Specifies configuration to build or clean. May be `Debug` or `Release` (default).
- `CFG`: Specifies configuration to build or clean. May be `Debug` or `Release` (default).
`PLAT`
Specifies driver platform to build. May be `Win32` or `x64` (default).
- `PLAT`: Specifies driver platform to build. May be `Win32` or `x64` (default).
## Usage