commit b906673e803d071afee3482249b8627570bc89d4
parent 297c9f1108691fd9fb0e0b3c71a7f920ac015d29
Author: Ryan Fu <69221034+ryfu-msft@users.noreply.github.com>
Date: Thu, 22 Dec 2022 13:39:23 -0800
Update PowerShell Module Dependency Docs (#2797)
Diffstat:
1 file changed, 9 insertions(+), 1 deletion(-)
diff --git a/src/PowerShell/Microsoft.WinGet.Client/README.md b/src/PowerShell/Microsoft.WinGet.Client/README.md
@@ -6,6 +6,14 @@ This project contains the source code for building the Windows Package Manager P
After building the project solution, the `Microsoft.WinGet.Client` PowerShell module can be found in the output directory in the `PowerShell` folder. For example if you built the project as x64 release, you should expect to find the module files in `$(SolutionDirectory)/src/x64/Release/PowerShell`.
+## Prerequisites
+
+The PowerShell module has a dependency on the latest [Microsoft Visual C++ Redistributable](https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist?view=msvc-170) package which can be downloaded or installed through the Windows Package Manager (WinGet) by running the following command:
+
+```
+winget install --id Microsoft.VCRedist.2015+.x64
+```
+
## Quick Start Guide
**To run the module, make sure you are using the latest version of PowerShell (not Windows PowerShell)**.
@@ -17,7 +25,7 @@ winget install --id Microsoft.Powershell
Import the module manifest (Microsoft.WinGet.Client.psd1) by running the following command:
```
-Import-Module <Path to Microsoft.WinGet.Client.psd1">
+Import-Module <Path to Microsoft.WinGet.Client.psd1>
```
The following cmdlets and functions are available for you to try:
