From 2a4c1fc0413228f4d4aca0c981409edaed7b5ee5 Mon Sep 17 00:00:00 2001 From: Mark Stega Date: Thu, 20 Jan 2022 15:52:13 -0500 Subject: Update ReadMe.md with build information --- README.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 58e0d6db..2842fa8f 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,53 @@ # WiX Toolset v4 This repository contains the WiX Toolset v4 codebase. + +# Developing WiX + +## Prerequisites + +Visual Studio 2022 (17.0.4 or higher, NOT the preview release) with the following installed: + +| Workloads | +| :-------- | +|ASP.Net and web development | +|.Net desktop development | +| Desktop development with C++ | + +| Individual components | +| :-------- | +|.Net Framework 4.7.2 SDK | +|.Net Framework 4.7.2 targeting pack | +| MSVC v141 - VS 2017 C++ ARM64 build tools (v14.16) | +| MSVC v141 - VS 2017 C++ x64/x86 build tools (v14.16) | +| MSVC v143 - VS 2022 C++ ARM64 build tools (Latest) | +| MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) | + +##### Getting started: +* Fork the WiX4 repository (https://github.com/wixtoolset/wix4.git) + into a github domain that you control +* Clone the WiX4 repository from your fork (git clone https://github.com/yourdomain/wix4.git) + into the directory of your choice + +##### To build the WiX toolset: + * Start a VS2022 'Developer Command Prompt' + * Change directory to the root of the cloned repository + * Issue the command 'build clean' (NB - The build is stateful so it is always good practice to do the clean before building) + * Issue the command 'build' (or 'build release' if you want to create a release version) + + ##### Executing your newly built WiX toolset + * 'build\wix\Debug\publish\wix\wix --help' (Of course changing Debug to Release if you built in Release mode) + + ##### Pull request expectations + * Pick an outstanding Wix4 issue (or create one). Add a comment requesting that you be assigned to the issue. Wait for confirmation. + * To create a PR fork a new branch from the develop branch + * Make changes to effect whatever changed behaviour is required for the PR + * Push the changes to your repository origin as needed + * If there are multiple commits squash them down to one commit. + * If the develop branch has changed since you created your new branch rebase to the current development branch. + * If needed (ie, you squashed or rebased), do a force push of your branch + * Create a PR with your branch against the WiX4 repository. + + + + -- cgit v1.2.3-55-g6feb