Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Squirrel Doc Updates - Misc items from Issues #1189

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/contributing/contributing.md → contributing.md
Original file line number Diff line number Diff line change
@@ -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 [[email protected]](mailto:[email protected]) with the email address you'd like to receive an invite.
Expand All @@ -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) |
|----|
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started/2-packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
17 changes: 14 additions & 3 deletions docs/using/debugging-updates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
~~~

Expand Down
10 changes: 3 additions & 7 deletions README.md → readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
| README.md |
| readme.md |
|:---|

![](docs/artwork/Squirrel-Logo.png)
Expand Down Expand Up @@ -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.



Expand Down