diff --git a/docs/contributing/building-squirrel.md b/docs/contributing/building-squirrel.md index 16cecc69..66b0f9c5 100644 --- a/docs/contributing/building-squirrel.md +++ b/docs/contributing/building-squirrel.md @@ -11,11 +11,10 @@ For the Impatient: git clone https://github.com/squirrel/squirrel.windows cd squirrel.windows git submodule update --init --recursive ## THIS IS THE PART YOU PROBABLY FORGOT -.\.NuGet\NuGet.exe restore -msbuild /p:Configuration=Release +devbuild.cmd ``` -**Tip:** You can compile the Squirrel.Windows solution with Visual Studio version 2013 and above (including community edition). +**Tip:** You can compile the Squirrel.Windows solution with Visual Studio version 2019 and above (including community edition). **Tip:** For Visual Studio versions that use the Visual Studio Installer (2017/2019 and above), you will need to have at least both Desktop .NET development and Desktop C++ development workloads checked in the Visual Studio Installer. You will also need to make sure that the individual package for the VC++ version used by Squirrel is checked. diff --git a/docs/using/machine-wide-installs.md b/docs/using/machine-wide-installs.md index a5fb21f1..e1e43f8d 100644 --- a/docs/using/machine-wide-installs.md +++ b/docs/using/machine-wide-installs.md @@ -1,24 +1,36 @@ -| [docs](..) / [using](.) / machine-wide-installs.md -|:---| - - +| [docs](..) / [using](.) / machine-wide-installs.md +|:---| + + # Machine-wide Installs - -Squirrel's Releasify command generates an MSI file suitable for installation via Group Policy. This MSI isn't a general-purpose installer, this means that once you run the MSI, users from now on will get the app installed, on next Login. - -So, most normal users should continue to run the Setup.exe's generated by Releasify, but if you want to have an IT Admin Friendly version, you can hand off the MSI - -Most users of Squirrel won't have to do anything new to enable this behavior, though certain NuGet package IDs / names might cause problems with MSI. - -**Source:** See [issue #466](https://github.com/Squirrel/Squirrel.Windows/issues/466) for more details. - -### Disabling MSI Generation -Generating MSIs can be disabled via the --no-msi flag as shown below: - -~~~powershell -PM> Squirrel --releasify MyApp.1.0.0.nupkg --no-msi -~~~ - ---- -| Return: [Table of Contents](../readme.md) | -|----| + +Squirrel's Releasify command generates an MSI file suitable for installation via Group Policy. This MSI isn't a general-purpose installer, this means that once you run the MSI, users from now on will get the app installed, on next Login. + +So, most normal users should continue to run the Setup.exe's generated by Releasify, but if you want to have an IT Admin Friendly version, you can hand off the MSI + +## Common pitfalls + +### Missing data in `.nuspec` + +Most users of Squirrel won't have to do anything new to enable this behavior, though certain NuGet package IDs / names might cause problems with MSI. + +**Source:** See [issue #466](https://github.com/Squirrel/Squirrel.Windows/issues/466) for more details. + +### Nothing happens on login + +In cases where the end user has previously installed your application, the installer that runs on login will not re-install your application on every login. This can easily be the case if you as a developer is testing out both the EXE and the MSI. + +Squirrel leaves behind an almost-empty `%LocalAppData%\MyApp` folder after an uninstall. Deleting this folder (the entire folder, not just the contents) will allow the installer that runs on login to install successfully. + +**Source:**: See [issue #555](https://github.com/Squirrel/Squirrel.Windows/issues/555#issuecomment-253265130) for details. + +## Disabling MSI Generation +Generating MSIs can be disabled via the --no-msi flag as shown below: + +~~~powershell +PM> Squirrel --releasify MyApp.1.0.0.nupkg --no-msi +~~~ + +--- +| Return: [Table of Contents](../readme.md) | +|----|