diff options
| author | 5an7y <[email protected]> | 2026-04-07 15:29:58 -0700 |
|---|---|---|
| committer | 5an7y <[email protected]> | 2026-04-07 15:29:58 -0700 |
| commit | 3a10b3c1ed4a2e611311e9ea3e931fc65fe1a9e8 (patch) | |
| tree | 848d99c1b4e3f425db30a03e239947129065d590 | |
| parent | 6b271bfe71e1994f9103e5988cf3ee1db0b7d0e6 (diff) | |
docs: streamline Building-Locally.md and fix typosuser/jvalesmena/build-environment
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 <[email protected]>
| -rw-r--r-- | Building-Locally.md | 44 |
1 files changed, 8 insertions, 36 deletions
diff --git a/Building-Locally.md b/Building-Locally.md index 290d5954..9d683a86 100644 --- a/Building-Locally.md +++ b/Building-Locally.md @@ -22,57 +22,29 @@ git clone --recurse-submodules "https://github.com/microsoft/Windows-driver-samp cd ".\Windows-driver-samples" ``` -Use `main` for in-market WDK releases, `develop` for WDK Preview / EEAP builds: +### Environment specific requisites -```powershell -git checkout main # stable / in-market -git checkout develop # preview / EEAP -``` - ---- - -## Building the Samples - -The script auto-detects which WDK environment is active. Use `-RunMode` to force a specific one if needed: - -```powershell -.\Build-Samples.ps1 -RunMode NuGet # force NuGet -.\Build-Samples.ps1 -RunMode EWDK # force EWDK -.\Build-Samples.ps1 -RunMode WDK # force WDK -``` - -### NuGet Package - -Install NuGet if you don't have it: +- If you are using the WDK via **NuGet**: install NuGet and restore the packages: ```powershell winget install --id Microsoft.NuGet --source winget -``` - -Restore the WDK packages and build from Powershell: - -```powershell nuget restore -PackagesDirectory ".\packages" -pwsh -.\Build-Samples.ps1 ``` -### EWDK - -Mount the EWDK ISO, open a terminal in the mounted drive, launch the build environment, then build: +- If you are using the WDK via **EWDK**: mount the EWDK ISO, open a terminal in the mounted drive, and launch the build environment: ```powershell .\LaunchBuildEnv -pwsh -.\Build-Samples.ps1 ``` -### WDK MSI/winget -Build the samples from PowerShell: +--- + +## Building the Samples + +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**: ```powershell -pwsh .\Build-Samples.ps1 ``` |