aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2019-04-14 08:48:00 +0200
committerJason A. Donenfeld <Jason@zx2c4.com>2019-04-14 08:48:00 +0200
commit82655e6e0e52b80eddc65565c354858f323a17b5 (patch)
tree4d75203700cd3d7a8025be2a724aa1384a998e7e /README.md
parentEstablish command line building support (diff)
downloadwintun-82655e6e0e52b80eddc65565c354858f323a17b5.tar.xz
wintun-82655e6e0e52b80eddc65565c354858f323a17b5.zip
Fixup readme markdown formatting
Signed-off-by: Jason A. Donenfeld <Jason@zx2c4.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 13 insertions, 17 deletions
diff --git a/README.md b/README.md
index 88ce3c5..c1a40d1 100644
--- a/README.md
+++ b/README.md
@@ -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