diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 50 insertions, 0 deletions
| @@ -7,3 +7,53 @@ | |||
| 7 | # WiX Toolset v4 | 7 | # WiX Toolset v4 |
| 8 | 8 | ||
| 9 | This repository contains the WiX Toolset v4 codebase. | 9 | This repository contains the WiX Toolset v4 codebase. |
| 10 | |||
| 11 | # Developing WiX | ||
| 12 | |||
| 13 | ## Prerequisites | ||
| 14 | |||
| 15 | Visual Studio 2022 (17.0.4 or higher, NOT the preview release) with the following installed: | ||
| 16 | |||
| 17 | | Workloads | | ||
| 18 | | :-------- | | ||
| 19 | |ASP.Net and web development | | ||
| 20 | |.Net desktop development | | ||
| 21 | | Desktop development with C++ | | ||
| 22 | |||
| 23 | | Individual components | | ||
| 24 | | :-------- | | ||
| 25 | |.Net Framework 4.7.2 SDK | | ||
| 26 | |.Net Framework 4.7.2 targeting pack | | ||
| 27 | | MSVC v141 - VS 2017 C++ ARM64 build tools (v14.16) | | ||
| 28 | | MSVC v141 - VS 2017 C++ x64/x86 build tools (v14.16) | | ||
| 29 | | MSVC v143 - VS 2022 C++ ARM64 build tools (Latest) | | ||
| 30 | | MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) | | ||
| 31 | |||
| 32 | ##### Getting started: | ||
| 33 | * Fork the WiX4 repository (https://github.com/wixtoolset/wix4.git) | ||
| 34 | into a github domain that you control | ||
| 35 | * Clone the WiX4 repository from your fork (git clone https://github.com/yourdomain/wix4.git) | ||
| 36 | into the directory of your choice | ||
| 37 | |||
| 38 | ##### To build the WiX toolset: | ||
| 39 | * Start a VS2022 'Developer Command Prompt' | ||
| 40 | * Change directory to the root of the cloned repository | ||
| 41 | * Issue the command 'build clean' (NB - The build is stateful so it is always good practice to do the clean before building) | ||
| 42 | * Issue the command 'build' (or 'build release' if you want to create a release version) | ||
| 43 | |||
| 44 | ##### Executing your newly built WiX toolset | ||
| 45 | * 'build\wix\Debug\publish\wix\wix --help' (Of course changing Debug to Release if you built in Release mode) | ||
| 46 | |||
| 47 | ##### Pull request expectations | ||
| 48 | * Pick an outstanding Wix4 issue (or create one). Add a comment requesting that you be assigned to the issue. Wait for confirmation. | ||
| 49 | * To create a PR fork a new branch from the develop branch | ||
| 50 | * Make changes to effect whatever changed behaviour is required for the PR | ||
| 51 | * Push the changes to your repository origin as needed | ||
| 52 | * If there are multiple commits squash them down to one commit. | ||
| 53 | * If the develop branch has changed since you created your new branch rebase to the current development branch. | ||
| 54 | * If needed (ie, you squashed or rebased), do a force push of your branch | ||
| 55 | * Create a PR with your branch against the WiX4 repository. | ||
| 56 | |||
| 57 | |||
| 58 | |||
| 59 | |||