Mirrors/velopack
1
0
Fork 0
mirror of https://github.com/velopack/velopack.git synced 2025-10-25 15:19:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
177fced3f467f111f3ec9e24ab1f132204921709
velopack/docfx/docs/index.md
Caelan Sayler 177fced3f4 docs: sort out landing pages
2024-01-27 12:19:03 +00:00

2.1 KiB
Raw Blame History

Velopack Documentation

🚧🚧This documentation is still under construction.🚧🚧

Velopack is an installation and auto-update framework for cross-platform .NET applications. It's opinionated, extremely easy to use with zero config needed. With just one command you can be up and running with an installable application, and it's lightning fast for your users, too.

Be sure to check us out on GitHub and join our Discord for any questions/support!

Overview

To enable your application to make full use of Velopack, you need to do 3 things:

  1. Add the SDK to your app, and check for updates. [Read more]
  2. Run the vpk command line tool to generate your update packages and installers. [Read more]
  3. Upload your release somewhere your app can download updates from. [Read more]

Tip

If you are migrating an application from Squirrel.Windows or Clowd.Squirrel, you may also want to read the migrating guide.

Quick Start

FAQ

  • My application was detected as a virus?
    Velopack can't help with this, but you can code-sign your app and check other suggestions here.
  • What happened to SquirrelAwareApp? / Shortcuts
    This concept no longer exists in Velopack. You can create hooks on install/update in a similar way using the VelopackApp builder. Although note that reating shortcuts or registry entries yourself during hooks is no longer required.
  • Can Velopack bootstrap new runtimes during updates?
    Yes, this is fully supported. Before installing updates, Velopack will prompt the user to install any missing updates.