Skip to content
This repository has been archived by the owner on Oct 8, 2024. It is now read-only.

Commit

Permalink
update lang readme's
Browse files Browse the repository at this point in the history
  • Loading branch information
caesay committed Feb 29, 2024
1 parent 98ebb89 commit b92fa93
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 8 deletions.
17 changes: 12 additions & 5 deletions for-cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,25 @@ static void update_app()
}
```

4. Compile your app to a program using your usual compiler (eg. msvc, cmake, gcc, etc)

5. Install the `vpk` command line tool:
4. Install the `vpk` command line tool:
```sh
dotnet tool update -g vpk
```
***Note: you must have the .NET Core SDK 6 installed to use and update `vpk`***

6. Package your Velopack release / installers:
5. Compile your app to a program using your usual compiler (eg. msvc, cmake, gcc, etc)

6. Copy `Vfusion.exe`, `VfusionMac` or `VfusionNix` to your build output folder. This is a manual step for now, but may be automated in the future. You can compile this yourself, download a [recent build artifact](https://github.com/velopack/velopack.fusion/actions), or grab the latest [npm release](https://www.npmjs.com/package/velopack?activeTab=code) which also bundles the binaries.

>[!WARNING]
>Until this is automated, failing to copy the fusion binary to your update directory will result in your app being unable to update.
7. Package your Velopack release / installers:
```sh
vpk pack -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe
```

✅ You're Done! Your app now has auto-updates and an installer.
You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice.
You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice.

Read the [Velopack Documentation](https://velopack.io/docs) or the [Velopack C++ Reference](https://velopack.io/ref/cpp/) for more information.
4 changes: 2 additions & 2 deletions for-js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ npx electron-forge package
```sh
dotnet tool update -g vpk
```
***Note: you must have the .NET Core SDK 6 installed to use and update the `vpk`***
***Note: you must have the .NET Core SDK 6 installed to use and update `vpk`***

7. Package your Velopack release / installers:
```sh
Expand All @@ -83,4 +83,4 @@ vpk pack -u MyAppUniqueId -v 1.0.0 -p /myBuildDir -e myexename.exe
✅ You're Done! Your app now has auto-updates and an installer.
You can upload your release to your website, or use the `vpk upload` command to publish it to the destination of your choice.

Read the Velopack documentation at [https://velopack.io/docs](https://velopack.io/docs) for more information.
Read the [Velopack Documentation](https://velopack.io/docs) or the [Velopack JS Reference](https://velopack.io/ref/js/) for more information.
2 changes: 1 addition & 1 deletion for-rust/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
//! ```sh
//! dotnet tool update -g vpk
//! ```
//! ***Note: you must have the .NET Core SDK 6 installed to use and update the `vpk`***
//! ***Note: you must have the .NET Core SDK 6 installed to use and update `vpk`***
//!
//! 6. Package your Velopack release / installers:
//! ```sh
Expand Down

0 comments on commit b92fa93

Please sign in to comment.