@@ -20,12 +20,12 @@ The DSC project is built using Rust and PowerShell. The build system automatical
2020### Required
2121
22221 . ** PowerShell** : Version 7.2 or later (cross-platform)
23- - Download from: https://github.com/PowerShell/PowerShell
23+ - Download from: < https://github.com/PowerShell/PowerShell >
2424 - The build script is invoked with ` pwsh `
2525
26262 . ** Rust** : Latest stable version
2727 - The build script can install/update Rust automatically
28- - Manual installation: https://rustup.rs/
28+ - Manual installation: < https://rustup.rs/ >
2929
3030### Automatically Installed by Build Script
3131
@@ -39,14 +39,17 @@ The `build.ps1` script automatically installs or verifies the following dependen
3939### Platform-Specific Requirements
4040
4141#### Windows
42+
4243- Visual Studio 2019 or later with C++ build tools (automatically checked)
4344- MakeAppx.exe (for creating MSIX packages)
4445
4546#### Linux
47+
4648- GCC or Clang
4749- Standard development tools (make, pkg-config)
4850
4951#### macOS
52+
5053- Xcode Command Line Tools
5154
5255## Quick Start
@@ -144,8 +147,9 @@ Build for a specific architecture:
144147### Build Artifacts
145148
146149After a successful build, artifacts are located in:
147- - ** bin/** : Compiled binaries and executables
148- - ** target/** : Rust build artifacts (debug or release)
150+
151+ - ` bin/ ` : Compiled binaries and executables
152+ - ` target/ ` : Rust build artifacts (debug or release)
149153
150154## Running Tests
151155
@@ -344,6 +348,7 @@ To simulate the CI workflow locally:
344348### Winget Workflow: winget.yml
345349
346350The ` winget.yml ` workflow publishes releases to Windows Package Manager (WinGet):
351+
347352- Triggered on release publication or manual workflow dispatch
348353- Only processes stable releases (not pre-releases)
349354- Creates WinGet package submission
@@ -355,6 +360,7 @@ The `winget.yml` workflow publishes releases to Windows Package Manager (WinGet)
355360#### Rust Not Found
356361
357362If Rust is not installed:
363+
358364``` powershell
359365# The build script will attempt to install Rust automatically
360366# Or manually install from: https://rustup.rs/
@@ -363,6 +369,7 @@ If Rust is not installed:
363369#### Build Fails on Windows
364370
365371Ensure Visual Studio C++ build tools are installed:
372+
366373``` powershell
367374# The build script checks and provides guidance
368375./build.ps1 -Verbose
@@ -371,6 +378,7 @@ Ensure Visual Studio C++ build tools are installed:
371378#### Tests Fail
372379
373380Check that the build completed successfully:
381+
374382``` powershell
375383# Ensure clean build before testing
376384./build.ps1 -Clean
@@ -380,6 +388,7 @@ Check that the build completed successfully:
380388#### Node.js or tree-sitter Missing
381389
382390The build script automatically installs these. If issues persist:
391+
383392``` powershell
384393# Re-run with verbose output
385394./build.ps1 -Verbose
@@ -414,14 +423,15 @@ The build script automatically installs these. If issues persist:
414423### Verbose Output
415424
416425For detailed build information:
426+
417427``` powershell
418428./build.ps1 -Verbose
419429```
420430
421431### Getting Help
422432
423433- Review error messages from the build script
424- - Check GitHub Issues: https://github.com/PowerShell/DSC/issues
434+ - Check GitHub Issues: < https://github.com/PowerShell/DSC/issues >
425435- See CONTRIBUTING.md for contribution guidelines
426436
427437## Validating Changes
@@ -444,6 +454,7 @@ Before submitting a pull request, validate your changes with the following comma
444454```
445455
446456This ensures your changes:
457+
447458- Build successfully with optimizations
448459- Pass all linting checks
449460- Pass all tests
@@ -456,4 +467,5 @@ This ensures your changes:
456467- ** Contributing Guide** : [ CONTRIBUTING.md] ( CONTRIBUTING.md )
457468- ** Documentation** : [ docs/] ( docs/ )
458469- ** Build Helper Module** : [ build.helpers.psm1] ( build.helpers.psm1 )
459- - ** Legacy Build Script** : [ packaging.ps1] ( packaging.ps1 ) (deprecated, use ` build.ps1 ` )
470+ - ** Legacy Build Script** : [ packaging.ps1] ( packaging.ps1 ) - legacy packaging script, retained for
471+ release packaging and certain package types (` rpm ` , ` deb ` ).
0 commit comments