Skip to content

Commit

Permalink
icon is no longer required
Browse files Browse the repository at this point in the history
  • Loading branch information
caesay committed Mar 30, 2024
1 parent 3442c65 commit 936fb91
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/packaging/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Henceforth this will be called `{build_dir}`.
- `--packVersion {version}` The current version you are releasing - in [semver2 format](https://semver.org/) (eg. `1.0.0-build.23+metadata`).
- `--packDir {build_dir}` The folder containing your compiled application.
- `--mainExe {exeName}` The main executable to be started after install, and the binary that will [handle Velopack Hooks](../integrating/overview.mdx).
- `--icon {path}` The icon used to bundle your app. Only required on MacOS and Linux.

:::tip
Velopack does not support 4 part versions (eg. `1.0.0.0`), as it would not be practical to support both formats simultaneously and semver2 offers a lot more flexibility.
Expand All @@ -33,6 +32,7 @@ vpk pack --packId MyAppId -packVersion 1.0.0 --packDir publish --mainExe MyApp.e
There are many optional arguments, the best way to see what features are available for your operating system is to check `vpk pack -h`. To mention a couple:
- `--packTitle {name}` The friendly name for your app, shown to users in dialogs, shortcuts, etc.
- `--outputDir {path}` The location Velopack should create the final releases (defaults to `.\Releases`)
- `--icon {path}` The icon used to bundle your app.

### Release output
When building a release has completed, you should have the following assets in your `--outputDir`:
Expand Down

0 comments on commit 936fb91

Please sign in to comment.