diff options
author | Jan Klass <kissaki@posteo.de> | 2021-05-29 13:23:55 +0300 |
---|---|---|
committer | Jan Klass <kissaki@posteo.de> | 2021-05-29 13:23:55 +0300 |
commit | 922e9321b27aa3edf5de46b742094f908b0d8c7b (patch) | |
tree | 93f70a157a93e96333ab8b65595a7b1ae986e4ae /docs | |
parent | 0d289f953575c2172331612eef7368f8fb6fe14b (diff) |
DOCS(installer): Fixup and extend installer build documentation
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/build-instructions/build_installer.md | 13 |
1 files changed, 10 insertions, 3 deletions
diff --git a/docs/dev/build-instructions/build_installer.md b/docs/dev/build-instructions/build_installer.md index d7edd898a..da3f09f78 100644 --- a/docs/dev/build-instructions/build_installer.md +++ b/docs/dev/build-instructions/build_installer.md @@ -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. |