Skip to content

Commit

Permalink
Improve README for Sample Configurations
Browse files Browse the repository at this point in the history
  • Loading branch information
denelon authored Nov 21, 2023
1 parent 4e41852 commit b6d702a
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion sampleConfigurations/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
## Using the sample configurations
Download the *.dsc.yaml files to your local system. They can be executed in Dev Home via the "Machine configuration" section. They can also be executed by running `winget configure <path to configuration file>`.

Several DSC resource will require running in administrator mode. If the configuration is leveraging the WinGet DSC resource to install packages, there are also limitations in some cases specific to the installers that may either require or prohibit installation in administrative context.

### GitHub projects
Sample configurations have been provided for various GitHub repositories. These configurations ideally should be placed in a `.configurations` folder in the root of the project directory. Some DSC resources may have parameters that allow you to pass in a relative file path. The reserved variable `$(WinGetConfigRoot)` can be used to specify the full path of the configuration file. An example of how to use that variable with a relative file path is shown below:

```yaml
Expand All @@ -12,4 +16,10 @@ Sample configurations have been provided for various GitHub repositories. These
productId: Microsoft.VisualStudio.Product.Community
channelId: VisualStudio.17.Release
vsConfigFile: '${WinGetConfigRoot}\..\.vsconfig'
```
```
### Learn to Code
The sample configurations in the Windows directory are related to [Windows development paths](https://learn.microsoft.com/windows/dev-environment/#development-paths).
### Sample DSC Resources
Examples for a few specific DSC Resources are under the DscResources directory.

0 comments on commit b6d702a

Please sign in to comment.