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

fix readme; we now support linux

Browse Source
This commit is contained in:
Caelan Sayler
2024-01-14 16:30:31 +00:00
parent b1b64f5bf7
commit e3dfc07af3
3 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -16,9 +16,9 @@ Velopack is a setup / installation framework for cross-platform dotnet applicati
## Features ## Features
- 😍 **Zero config** – Velopack takes your dotnet build output (eg. `dotnet publish`), and generates an installer, and update package in a single command. - 😍 **Zero config** – Velopack takes your dotnet build output (eg. `dotnet publish`), and generates an installer, and update package in a single command.
- 🎯 **Cross platform** – Velopack supports building packages for Windows and OSX, with Linux on the way. No matter your target, Velopack can create a release in just one command. - 🎯 **Cross platform** – Velopack supports building packages for **Windows**, **OSX**, and **Linux**. No matter your target, Velopack can create a release in just one command.
- 🚀 **Automatic migrations** - If you are coming from [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) or [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel), Velopack will automatically migrate your application. Just build your Velopack release and deploy! [Read more.](docs/migrating.md) - 🚀 **Automatic migrations** - If you are coming from [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) or [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel), Velopack will automatically migrate your application. Just build your Velopack release and deploy! [Read more.](docs/migrating.md)
- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for fast app updates. Applying update packages is highly optimised, and often can be done in the background. - ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for ultra fast app updates. Applying update packages is highly optimised, and often can be done in the background.
## Getting Started ## Getting Started
This is a very simple example of the steps you would take to generate an installer and update packages for your application. Be sure to [read the documentation](docs) for an overview of more features! This is a very simple example of the steps you would take to generate an installer and update packages for your application. Be sure to [read the documentation](docs) for an overview of more features!
@@ -27,7 +27,7 @@ This is a very simple example of the steps you would take to generate an install
```cmd ```cmd
dotnet tool install -g vpk dotnet tool install -g vpk
``` ```
2. Install the [Velopack NuGet Package](https://www.nuget.org/packages/velopack) in your main project: 2. Install the [Velopack NuGet Package](https://www.nuget.org/packages/velopack) in your main project:
```cmd ```cmd
dotnet add package Velopack dotnet add package Velopack
``` ```
@@ -36,6 +36,7 @@ This is a very simple example of the steps you would take to generate an install
static void Main(string[] args) static void Main(string[] args)
{ {
VelopackApp.Build().Run(); VelopackApp.Build().Run();
// ... your other startup code below
} }
``` ```
4. Publish dotnet and build your first Velopack release! 🎉 4. Publish dotnet and build your first Velopack release! 🎉

4
README_NUGET.md
View File

@@ -4,9 +4,9 @@ Velopack is a setup / installation framework for cross-platform dotnet applicati
## Features ## Features
- 😍 **Zero config** – Velopack takes your dotnet build output (eg. `dotnet publish`), and generates an installer, and update package in a single command. - 😍 **Zero config** – Velopack takes your dotnet build output (eg. `dotnet publish`), and generates an installer, and update package in a single command.
- 🎯 **Cross platform** – Velopack supports building packages for Windows and OSX, with Linux on the way. No matter your target, Velopack can create a release in just one command. - 🎯 **Cross platform** – Velopack supports building packages for Windows and OSX, and Linux. No matter your target, Velopack can create a release in just one command.
- 🚀 **Automatic migrations** - If you are coming from [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) or [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel), Velopack will automatically migrate your application. Just build your Velopack release and deploy! [Read more.](docs/migrating.md) - 🚀 **Automatic migrations** - If you are coming from [Squirrel.Windows](https://github.com/Squirrel/Squirrel.Windows) or [Clowd.Squirrel](https://github.com/clowd/Clowd.Squirrel), Velopack will automatically migrate your application. Just build your Velopack release and deploy! [Read more.](docs/migrating.md)
- ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for fast app updates. Applying update packages is highly optimised, and often can be done in the background. - ⚡️ **Lightning fast** – Velopack is written in Rust for native performance. Creating releases is multi-threaded, and produces delta packages for ultra fast app updates. Applying update packages is highly optimised, and often can be done in the background.
## Getting Started ## Getting Started

1
Velopack.sln
View File

@@ -13,6 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SolutionLevel", "SolutionLe
.github\workflows\build.yml = .github\workflows\build.yml .github\workflows\build.yml = .github\workflows\build.yml
src\Directory.Build.props = src\Directory.Build.props src\Directory.Build.props = src\Directory.Build.props
test\Directory.Build.props = test\Directory.Build.props test\Directory.Build.props = test\Directory.Build.props
nuget.config = nuget.config
README.md = README.md README.md = README.md
Velopack.entitlements = Velopack.entitlements Velopack.entitlements = Velopack.entitlements
version.json = version.json version.json = version.json