diff --git a/README.md b/README.md index 0f99ad68..3d623373 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ [![Codecov](https://img.shields.io/codecov/c/github/velopack/velopack?style=flat-square)](https://app.codecov.io/gh/velopack/velopack) [![License](https://img.shields.io/github/license/velopack/velopack?style=flat-square)](https://github.com/velopack/velopack/blob/develop/LICENSE) -Velopack is a setup / installation framework for cross-platform dotnet applications. Great out-of-the-box development experience, with zero configuration or setup needed. Lightning fast to use, and lightning fast for your users, too. +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. ## Features diff --git a/README_NUGET.md b/README_NUGET.md index 6e346a96..e46827d0 100644 --- a/README_NUGET.md +++ b/README_NUGET.md @@ -1,5 +1,5 @@ # Velopack -Velopack is a setup / installation framework for cross-platform dotnet applications. Great out-of-the-box development experience, with zero configuration or setup needed. Lightning fast to use, and lightning fast for your users, too. +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. ## Features diff --git a/docfx/.gitignore b/docfx/.gitignore index 750cbf12..57592108 100644 --- a/docfx/.gitignore +++ b/docfx/.gitignore @@ -1,2 +1,3 @@ api/ +sdk/ _site/ \ No newline at end of file diff --git a/docfx/docfx.json b/docfx/docfx.json index cc789eb8..0ff0bc89 100644 --- a/docfx/docfx.json +++ b/docfx/docfx.json @@ -9,7 +9,7 @@ ] } ], - "dest": "api" + "dest": "sdk" } ], "build": { diff --git a/docfx/docs/index.md b/docfx/docs/index.md new file mode 100644 index 00000000..7348f3d4 --- /dev/null +++ b/docfx/docs/index.md @@ -0,0 +1,28 @@ +# 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](https://github.com/velopack/velopack) and [join our Discord](https://discord.gg/CjrCrNzd3F) 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]](updating/overview.md) +0. Run the `vpk` command line tool to generate your update packages and installers. [[Read more]](packaging/overview.md) +0. Upload your release somewhere your app can download updates from. [[Read more]](distributing/overview.md) + +> [!TIP] +> If you are migrating an application from Squirrel.Windows or Clowd.Squirrel, you may also want to read [the migrating guide](migrating.md). + +## Quick Start +- [C# .NET Quick Start](getting-started/csharp.md) +- Sample App: [Avalonia Cross Platform](https://github.com/velopack/velopack/tree/master/examples/AvaloniaCrossPlat) +- Sample App: [WPF / .Net Framework](https://github.com/velopack/velopack/tree/master/examples/VeloWpfSample) + +## FAQ +- **My application was detected as a virus?**
+ Velopack can't help with this, but you can [code-sign](packaging/signing.md) your app and check [other suggestions here](https://github.com/clowd/lowd.Squirrel/issues/28#issuecomment-1016241760). +- **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. \ No newline at end of file diff --git a/docfx/docs/toc.yml b/docfx/docs/toc.yml index 7d21feb7..f53dfac4 100644 --- a/docfx/docs/toc.yml +++ b/docfx/docs/toc.yml @@ -1,5 +1,5 @@ - name: Welcome - href: welcome.md + href: index.md - name: Getting Started href: getting-started/toc.yml @@ -12,6 +12,10 @@ - name: C# WPF / .Net Framework href: https://github.com/velopack/velopack/tree/master/examples/VeloWpfSample +- name: App Updating + href: updating/toc.yml + homepage: updating/overview.md + - name: Packaging Releases href: packaging/toc.yml homepage: packaging/overview.md @@ -20,10 +24,6 @@ href: distributing/toc.yml homepage: distributing/overview.md -- name: Updating - href: updating/toc.yml - homepage: updating/overview.md - - name: Troubleshooting href: troubleshooting/toc.yml homepage: troubleshooting/debugging.md diff --git a/docfx/docs/welcome.md b/docfx/docs/welcome.md deleted file mode 100644 index e519f50c..00000000 --- a/docfx/docs/welcome.md +++ /dev/null @@ -1,11 +0,0 @@ -# Velopack Documentation -🚧🚧This documentation is still under construction.🚧🚧 - -## FAQ - - **My application was detected as a virus?**
- Velopack can't help with this, but you can [code-sign](packaging/signing.md) your app and check [other suggestions here](https://github.com/clowd/Clowd.Squirrel/issues/28#issuecomment-1016241760). - - **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 creating 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. - diff --git a/docfx/hello.html b/docfx/hello.html deleted file mode 100644 index e69de29b..00000000 diff --git a/docfx/index.html b/docfx/index.html new file mode 100644 index 00000000..57832eaf --- /dev/null +++ b/docfx/index.html @@ -0,0 +1,7 @@ + + Welcome, there's nothing here, you're probably looking for the documentation. + + + \ No newline at end of file diff --git a/docfx/index.md b/docfx/index.md index 128644b2..60668491 100644 --- a/docfx/index.md +++ b/docfx/index.md @@ -2,6 +2,4 @@ _layout: landing --- -# WIP - -You probably just want to visit [the documentation](docs/welcome.md). \ No newline at end of file +[!INCLUDE [index](index.html)] \ No newline at end of file diff --git a/docfx/templates/velopack/public/main.js b/docfx/templates/velopack/public/main.js index 4229c0ed..5af7bf18 100644 --- a/docfx/templates/velopack/public/main.js +++ b/docfx/templates/velopack/public/main.js @@ -4,6 +4,11 @@ export default { icon: 'github', href: 'https://github.com/velopack/velopack', title: 'GitHub' + }, + { + icon: 'discord', + href: 'https://discord.gg/CjrCrNzd3F', + title: 'Discord' } ] } \ No newline at end of file diff --git a/docfx/toc.yml b/docfx/toc.yml index 061acc65..3f0f74bd 100644 --- a/docfx/toc.yml +++ b/docfx/toc.yml @@ -1,4 +1,4 @@ - name: Docs href: docs/ -- name: API - href: api/ \ No newline at end of file +- name: C# SDK + href: sdk/ \ No newline at end of file