Skip to content

Commit 3a10b3c

Browse files
5an7yCopilot
andcommitted
docs: streamline Building-Locally.md and fix typos
Simplify prerequisites with environment-specific requisites section, remove redundant build commands per WDK type since the script auto-detects. Fix typo (Enviroment), casing (powershell), formatting. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 6b271bf commit 3a10b3c

1 file changed

Lines changed: 8 additions & 36 deletions

File tree

Building-Locally.md

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -22,57 +22,29 @@ git clone --recurse-submodules "https://github.com/microsoft/Windows-driver-samp
2222
cd ".\Windows-driver-samples"
2323
```
2424

25-
Use `main` for in-market WDK releases, `develop` for WDK Preview / EEAP builds:
25+
### Environment specific requisites
2626

27-
```powershell
28-
git checkout main # stable / in-market
29-
git checkout develop # preview / EEAP
30-
```
31-
32-
---
33-
34-
## Building the Samples
35-
36-
The script auto-detects which WDK environment is active. Use `-RunMode` to force a specific one if needed:
37-
38-
```powershell
39-
.\Build-Samples.ps1 -RunMode NuGet # force NuGet
40-
.\Build-Samples.ps1 -RunMode EWDK # force EWDK
41-
.\Build-Samples.ps1 -RunMode WDK # force WDK
42-
```
43-
44-
### NuGet Package
45-
46-
Install NuGet if you don't have it:
27+
- If you are using the WDK via **NuGet**: install NuGet and restore the packages:
4728

4829
```powershell
4930
winget install --id Microsoft.NuGet --source winget
50-
```
51-
52-
Restore the WDK packages and build from Powershell:
53-
54-
```powershell
5531
nuget restore -PackagesDirectory ".\packages"
56-
pwsh
57-
.\Build-Samples.ps1
5832
```
5933

60-
### EWDK
61-
62-
Mount the EWDK ISO, open a terminal in the mounted drive, launch the build environment, then build:
34+
- If you are using the WDK via **EWDK**: mount the EWDK ISO, open a terminal in the mounted drive, and launch the build environment:
6335

6436
```powershell
6537
.\LaunchBuildEnv
66-
pwsh
67-
.\Build-Samples.ps1
6838
```
6939

70-
### WDK MSI/winget
7140

72-
Build the samples from PowerShell:
41+
---
42+
43+
## Building the Samples
44+
45+
The `Build-Samples.ps1` script auto-detects which WDK environment is active and will build all the samples with all the configurations by default. Just run the following command from **PowerShell**:
7346

7447
```powershell
75-
pwsh
7648
.\Build-Samples.ps1
7749
```
7850

0 commit comments

Comments
 (0)