Merge pull request #3031 from ppoelzl/release-documentation

Describe installer creation process
This commit is contained in:
Wires77
2021-08-06 13:24:58 -05:00
committed by GitHub

View File

@@ -61,3 +61,36 @@ Steps:
won't trigger.
7. Restart Path of Building Community. This should result in a new file `tree.lua`.
8. Remove `data.json` from the new directory. Do not commit this file.
## Installer creation
Path of Building Community offers both installable and standalone releases. They're
built with automation scripts found in the repository described below.
Prerequisites:
- Have Git 2.21.0+ installed and `git` in your `PATH`.
Verify by running `git --version`.
- Have NSIS 3.07+ installed and `makensis` in your `PATH`.
Verify by running `makensis /version`.
You may have to add this manually after installation.
- Have Python 3.7+ installed and `python` in your `PATH`.
Verify by running `python --version`.
- NB: You don't have to create a virtual environment, as you don't need to install any
third-party libraries.
Installation:
- Clone this repository to a directory of your choice:
git clone https://github.com/PathOfBuildingCommunity/PathOfBuildingInstaller.git
- Please note that you might not have access to this repository if you're not a Path of
Building Community maintainer.
Usage:
python make_release.py
- To change the output folder or repository URL, simply edit the script file.
- Created installers can be found in the `./Dist` directory.
- NB: Output like the following can be safely ignored. This is due to NSIS complaining
about including an empty directory.
AppData\Local\Temp\tmp5fo1ha19\Update -> no files found. (NSIS/Setup.nsi:158)