commit cdcf6d6ae45884590256360208f4747bdeb72fb4
parent f3b159574719f07d45f4e93a640d138767cda4ec
Author: Joel Stidley <30506169+joelst@users.noreply.github.com>
Date: Fri, 28 Aug 2020 14:42:01 -0500
Update Settings.md (#552)
- Removed extraneous comma after experimentalArg line. If the comma was intentional, you can reject the change.
- Added the example for configuring experimentalMSStore.
- Modified winget to WinGet when referencing the name and not the command line.
- Moved experimentalMSStore to be a sub-section to experimentalFeatures.
Diffstat:
1 file changed, 14 insertions(+), 11 deletions(-)
diff --git a/doc/Settings.md b/doc/Settings.md
@@ -1,16 +1,16 @@
# WinGet CLI Settings
-You can configure WinGet by editing the `settings.json` file. The file can be opened with the default json editor by running `winget settings`. If no editor is configured, notepad.exe will be used.
+You can configure WinGet by editing the `settings.json` file. Running `winget settings` will open the file in the default json editor, if no editor is configured, notepad.exe is used.
## File Location
Settings file is located in %LOCALAPPDATA%\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\LocalState\settings.json
-If you are using the non-packaged winget version by building it from source code, the file will be located under %LOCALAPPDATA%\Microsoft\WinGet\Settings\settings.json
+If you are using the non-packaged WinGet version by building it from source code, the file will be located under %LOCALAPPDATA%\Microsoft\WinGet\Settings\settings.json
## Source
-These settings involve configuration to the WinGet source.
+The `source` settings involve configuration to the WinGet source.
```
"source": {
@@ -29,7 +29,7 @@ To manually update the source use `winget source update`
## Visual
-These settings involve visual elements that are displayed by WinGet
+The `visual` settings involve visual elements that are displayed by WinGet
```
"visual": {
@@ -47,19 +47,23 @@ Color of the progress bar that WinGet displays when not specified by arguments.
## Experimental Features
-In order to allow work to be done in master, and distributed to early adopters for their feedback, settings have the ability to control "experimental" features.
+To allow work to be done and distributed to early adopters for feedback, settings can be used to enable "experimental" features.
-### experimentalFeatures
-
-This is the root node representing experimental features. Individual feature can be enabled under this node. Below are the sample ones.
+The `experimentalFeatures` settings involve the configuration of these "experimental" features. Individual features can be enabled under this node. The example below shows sample experimental features.
```
"experimentalFeatures": {
"experimentalCmd": true,
- "experimentalArg": false,
+ "experimentalArg": false
},
```
### experimentalMSStore
-The winget Microsoft Store App support is currently implemented as an experimental feature. It supports a curated list of utilitiy apps from Microsoft Store.-
\ No newline at end of file
+Microsoft Store App support in WinGet is currently implemented as an experimental feature. It supports a curated list of utilitiy apps from Microsoft Store. You can enable the feature as shown below.
+
+```
+ "experimentalFeatures": {
+ "experimentalMSStore": true
+ },
+```