diff --git a/installer/README.md b/installer/README.md index 527b736d39..a3d4006884 100644 --- a/installer/README.md +++ b/installer/README.md @@ -1,24 +1,27 @@ # PowerToys Setup Project -## Build instructions - * Install the [WiX Toolset Visual Studio 2019 Extension](https://marketplace.visualstudio.com/items?itemName=RobMensching.WiXToolset). - * Install the [WiX Toolset build tools](https://wixtoolset.org/releases/) in the development machine. - * Open `powertoys.sln`, select the "Release" and "x64" configurations and build the `PowerToysSetup` project. - * The resulting installer will be built to `PowerToysSetup\bin\Release\PowerToysSetup.msi`. +## MSIX instructions -## Building and installing self-signed PowerToys MSIX package +### 1-time Run + +#### Create Self-sign certificate For the first-time installation, you'll need to generate a self-signed certificate. The script below will generate and add a cert to your [TRCA store](https://docs.microsoft.com/en-us/windows-hardware/drivers/install/trusted-root-certification-authorities-certificate-store). 1. Open `Developer PowerShell for VS` as an Admin 2. Navigate to your repo's `installer\MSIX` 3. Run `.\generate_self_sign_cert.ps1` -## To Build +#### Elevate `Developer PowerShell for VS` permissions +`msix_reinstall.ps1` is unsigned, you'll need to elevate your prompt. +1. Open `Developer PowerShell for VS` as admin +2. Run `Set-ExecutionPolicy -executionPolicy Unrestricted` + +### To Build MSIX 1. Make sure you've built the `Release` configuration of `powertoys.sln` 2. Open `Developer PowerShell for VS` 3. Navigate to your repo's `installer\MSIX` 4. Run `.\msix_reinstall.ps1` from the devenv powershell -### What msix_reinstall.ps1 does +#### What msix_reinstall.ps1 does `msix_reinstall.ps1` removes the current PowerToys installation, restarts explorer.exe (to update PowerRename shell extension), builds `PowerToys-x64.msix` package, signs it with a PowerToys_TemporaryKey.pfx, and finally installs it. #### Removing all .msi/.msix PowerToys installations @@ -30,3 +33,9 @@ gwmi win32_product -filter "Name = '$name'" -namespace root/cimv2 | foreach { else { write-warning "Failed to uninstall $name." } } ``` + +## MSI Build instructions (Deprecated) + * Install the [WiX Toolset Visual Studio 2019 Extension](https://marketplace.visualstudio.com/items?itemName=RobMensching.WiXToolset). + * Install the [WiX Toolset build tools](https://wixtoolset.org/releases/) in the development machine. + * Open `powertoys.sln`, select the "Release" and "x64" configurations and build the `PowerToysSetup` project. + * The resulting installer will be built to `PowerToysSetup\bin\Release\PowerToysSetup.msi`.