velopack/docs

docs / readme.md

Table of Contents

This document provides a table of contents for all the Squirrel documentation.

General Documentation

• Squirrel Goals - overview of the goals of the Squirrel.Windows project.
• Frequently Asked Questions (FAQ) - list of frequently asked questions.
• Squirrel.Windows License - copyright and license for using Squirrel.Windows

Getting Started Guide

The Getting Started Guide provides a step-by-step guide for integrating Squirrel into a simple Windows Forms application named MyApp.

1. Integrating - integrating Squirrel UpdateManager into MyApp.
2. Packaging - packaging MyApp files and preparing them for release.
3. Distributing - providing install and update files for MyApp.
4. Installing - process of initial installation of MyApp.
5. Updating - process of updating an existing install of MyApp.

Using Squirrel

• Installing - documentation related to the initial installation of your application via Setup.exe (and Setup.msi).
  • Install Process - overview of the steps in the install process.
  • Custom Squirrel Events - preforming custom actions for Squirrel events.
  • Custom Squirrel Events (non-c# apps) - steps on making a non-c# application Squirrel Aware and handling custom events.
  • Loading GIF - specify a "loading" image during initial install of large applications.
  • GitHub - overview of using GitHub for installing, distributing, and updating.
  • Machine-wide Installs - generating an MSI file suitable for installation via Group Policy.
  • Debugging Installs - tips for debugging Squirrel.Windows initial installs.
• Packaging - documentation related to packaging app files and preparing them for release.
  • Naming Conventions - overview of sources used in naming (e.g., shortcut name).
  • NuGet Package Metadata - overview of the NuGet metadata and its uses by Squirrel.
  • Packaging Tools - tools available to assist in the process of packaging your application (e.g., NuGet, OctoPack, Auto.Squirrel)
  • Squirrel Command Line - command line options for Squirrel --releasify
  • Delta Packages - an overview of how Squirrel.exe creates delta packages.
  • Application Signing - adding code signing to Setup.exe and your application.
• Distributing - documentation related to distributing the Setup.exe and update package files.
  • Microsoft IIS - overview of using Microsoft IIS for distributing your application.
  • Amazon S3 - overview of using Amazon S3 for distributing your application.
  • GitHub - overview of using GitHub for installing, distributing, and updating.
• Updating - documentation related to updating an existing install via the UpdateManager.
  • Update Process - overview of the steps in the update process.
  • Update Manager - reference guide for the UpdateManager.
  • GitHub - overview of using GitHub for installing, distributing, and updating.
  • Debugging Updates - tips for debugging Squirrel.Windows updates.
  • Staged Rollouts - how to use staged rollouts to ramp up install distribution over time

Contributing

Why not give back and help make Squirrel even better by contributing to the project.

• Contributing - overview of ways you can become more involved with Squirrel.Windows.
• Building Squirrel - steps to build squirrel for the impatient.
• VS Solution Overview - overview of the various projects in the Squirrel.Windows Visual Studio solution.
• Branching Strategy - overview of the different branches used in squirrel development.