Skip to content

Update renamed MSI image options #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
s3cody wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Update renamed MSI image options #71

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/packaging/installer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,12 @@ The `--instLocation` option controls where the MSI will install:
| `--instLicense {path}` | License agreement (`.txt`, `.md`, or `.rtf`) |
| `--instReadme {path}` | Readme message (`.txt` or `.md`) |
| `--instConclusion {path}` | Conclusion message (`.txt` or `.md`) |
| `--msiBanner {path}` | Top banner image for MSI dialogs (`.bmp`, 493x58) |
| `--msiLogo {path}` | Background logo for MSI dialogs (`.bmp`, 493x312) |
| `--msiTopBanner {path}` | Narrow banner across the top of MSI dialogs (`.bmp`, 493x58) |
| `--msiDialogBackground {path}` | Full background of the MSI welcome and completion dialogs (`.bmp`, 493x312) |

:::note
The MSI image options were renamed from `--msiBanner` and `--msiLogo`. Update existing packaging scripts to use `--msiTopBanner` and `--msiDialogBackground`, respectively.
:::

#### Directory Structure
The MSI installs the same directory layout as `Setup.exe` (see [the canonical layout on the Windows page](operating-systems/windows.mdx)), under `{installFolder}` instead of `%LocalAppData%\{packId}`.
Expand Down