Skip to content

Commit

Permalink
Merge PR mumble-voip#5059: DOCS(installer): Fixup and extend installe…
Browse files Browse the repository at this point in the history
…r build documentation
  • Loading branch information
Kissaki authored May 29, 2021
2 parents 0d289f9 + 922e932 commit b0cb787
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions docs/dev/build-instructions/build_installer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,16 @@

Currently, the installer creation has been tested on Windows only.

For creating the installer, [WixSharp](https://github.com/oleg-shilo/wixsharp/releases) has to be present on your system. Please see the following [README](https://github.com/oleg-shilo/wixsharp/blob/master/README.md) for install information.
For creating the installer, [WixSharp](https://github.com/oleg-shilo/wixsharp) has to be present on your system.

An installer can be created after invoking cmake with the `-Dpackaging=ON` and `-Dtranslations=OFF` options, and building. This creates a *single-language* installer.
1. Download the [latest WixSharp release](https://github.com/oleg-shilo/wixsharp/releases)
2. Extract into a folder
3. Add that folder to the PATH environment variable

To create a *multi-language* installer, make sure the following option is set `-Dpackaging=ON` and (re-)run the cmake configure step. Multi-language packaging is the default.
The cmake option `packaging`, off by default, specifies whether or not to build the installer. If being built it will be multi-lingual by default.

Use the cmake generate option `-Dpackaging=ON` to enable building the installer.

Use the additional cmake generate option `-Dtranslations=OFF` to build a single-language installer instead.

Note that the installers expect some components to be built. For example, the client installer expects the `g15` component to be built too. Without it packaging will fail on the missing expected file.

0 comments on commit b0cb787

Please sign in to comment.