diff --git a/docs/contributing/contributing.md b/contributing.md similarity index 67% rename from docs/contributing/contributing.md rename to contributing.md index 75868f403..bcf83fb3c 100644 --- a/docs/contributing/contributing.md +++ b/contributing.md @@ -1,8 +1,8 @@ -| [docs](..) / [contributing](.) / contributing.md +| contributing.md |:---| -# Contributing - +# Contributing + Why not give back and help make Squirrel even better? Here is an overview of ways you can become more involved. * **Join the Squirrel Slack Room** - email [paul@paulbetts.org](mailto:paul@paulbetts.org) with the email address you'd like to receive an invite. @@ -13,9 +13,9 @@ Why not give back and help make Squirrel even better? Here is an overview of way ## See Also -* [Building Squirrel](building-squirrel.md) - steps to build squirrel for the impatient. -* [VS Solution Overview](vs-solution-overview.md) - overview of the various projects in the Squirrel.Windows Visual Studio solution. +* [Building Squirrel](docs/contributing/building-squirrel.md) - steps to build squirrel for the impatient. +* [VS Solution Overview](docs/contributing/vs-solution-overview.md) - overview of the various projects in the Squirrel.Windows Visual Studio solution. --- -| Return: [Table of Contents](../readme.md) | +| Return: [Table of Contents](docs/readme.md) | |----| diff --git a/COPYING b/copying similarity index 100% rename from COPYING rename to copying diff --git a/docs/faq.md b/docs/faq.md index ab5ff16bc..bc352ef76 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -8,7 +8,7 @@ Frequently Asked Questions for Squirrel.Windows, organized by area below. ## Integrating 1. **Can Squirrel.Windows be used on applications that aren't made with .Net?** - Yes, you can package a non-c# application in the same manner as described in the Getting Started guide. For additional customization, see [custom squirrel events for non-c# apps](using/custom-squirrel-events-non-CS.md). + Yes, you can package a non-c# application in the same manner as described in the Getting Started guide. For additional customization, see [custom squirrel events for non-c# apps](using/custom-squirrel-events-non-cs.md). 1. **How do I migrate a ClickOnce app to Squirrel?** You may want to look into the [ClickOnceToSquirrelMigrator](https://github.com/flagbug/ClickOnceToSquirrelMigrator) migration helper. 1. **How can I determine if my app is a Squirrel app? I provide a squirrel and non-squirrel install version and want to know which is running.** diff --git a/docs/getting-started/2-packaging.md b/docs/getting-started/2-packaging.md index 61d7a9a53..72fcb482e 100644 --- a/docs/getting-started/2-packaging.md +++ b/docs/getting-started/2-packaging.md @@ -56,6 +56,8 @@ PM> Squirrel --releasify MyApp.1.0.0.nupkg **Tip:** If you get an error stating that `...'Squirrel' is not recognized...` then you may simply need to restart Visual Studio so the `Package Manager Console` will have loaded all the package tools. +**Tip:** Be aware, the `releasify` command "injects" your current application into a copy of the Setup.exe application. Virus scanners may detect this behavior as malicious and block it. You may need to exclude the Squirrel.exe (found in packages) and/or your project directory in your virus scanner settings. + ### Releasify Output The `Squirrel --releasify` command completes the following: diff --git a/docs/readme.md b/docs/readme.md index 8aa7d8a2c..88d2b0cfd 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -57,6 +57,6 @@ The **[Getting Started Guide](getting-started/0-overview.md)** provides a step-b Why not give back and help make Squirrel even better by contributing to the project. -* [Contributing](contributing/contributing.md) - overview of ways you can become more involved with Squirrel.Windows. +* [Contributing](../contributing.md) - overview of ways you can become more involved with Squirrel.Windows. * [Building Squirrel](contributing/building-squirrel.md) - steps to build squirrel for the impatient. * [VS Solution Overview](contributing/vs-solution-overview.md) - overview of the various projects in the Squirrel.Windows Visual Studio solution. diff --git a/docs/using/debugging-updates.md b/docs/using/debugging-updates.md index 89c7e690b..d97a4b059 100644 --- a/docs/using/debugging-updates.md +++ b/docs/using/debugging-updates.md @@ -21,16 +21,27 @@ Executing MyApp from Visual Studio will now cause it to complete the update proc ![](images/debugging-update-dir.png) -**Tip:** If you want to ensure that the Update.exe is always available in your output directory, you can add the Update.exe file to the Visual Studio project and set its Properties > Copy To Output Directory to 'Copy if newer'. +**Tip:** If you want to ensure that the Update.exe is automatically created in your bin directory, you can add the following `Post-build event command line` in your Project > Properties > Build Events. + +``` +echo Dummy file for Squirrel App debugging created in Post-build Event > "$(ProjectDir)bin\Update.exe" +``` ## Catching Update Exceptions You can catch thrown exceptions and log the results. ~~~cs -using (var mgr = new UpdateManager("C:\\Projects\\MyApp\\Releases")) +try +{ + using (var mgr = new UpdateManager("C:\\Projects\\MyApp\\Releases")) + { + await mgr.UpdateApp(); + } +} +catch (Exception ex) { - await mgr.UpdateApp(); + Console.WriteLine("Error in Squirrel Update:" + ex.Message); } ~~~ diff --git a/README.md b/readme.md similarity index 90% rename from README.md rename to readme.md index 320e8f282..2f52189e5 100644 --- a/README.md +++ b/readme.md @@ -1,4 +1,4 @@ -| README.md | +| readme.md | |:---| ![](docs/artwork/Squirrel-Logo.png) @@ -34,16 +34,12 @@ cd squirrel.windows .\.NuGet\NuGet.exe restore msbuild /p:Configuration=Release ``` -See [Contributing](docs/contributing/contributing.md) for additional information on building and contributing to Squirrel. +See [contributing](contributing.md) for additional information on building and contributing to Squirrel. ## License and Usage -See [COPYING](COPYING) for details on copyright and usage of the Squirrel.Windows software. - - - - +See [copying](copying) for details on copyright and usage of the Squirrel.Windows software.