aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md42
1 files changed, 31 insertions, 11 deletions
diff --git a/README.md b/README.md
index 127330ca..bda7b009 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
1<img src="https://github.com/wixtoolset/Home/raw/master/imgs/wix-white-bg.png" alt="WiX Toolset" height="128" /> 1![The WiX Toolset Logo](https://github.com/wixtoolset/.github/raw/master/profile/images/readme-header.png)
2 2
3[![latest version](https://img.shields.io/nuget/vpre/wix)](https://www.nuget.org/packages/wix) 3[![latest version](https://img.shields.io/nuget/vpre/wix)](https://www.nuget.org/packages/wix)
4[![download count](https://img.shields.io/nuget/dt/wix)](https://www.nuget.org/stats/packages/WiX?groupby=Version) 4[![download count](https://img.shields.io/nuget/dt/wix)](https://www.nuget.org/stats/packages/WiX?groupby=Version)
@@ -6,14 +6,27 @@
6 6
7# WiX Toolset 7# WiX Toolset
8 8
9This repository contains the WiX Toolset codebase. 9The WiX Toolset is the most powerful set of tools available to create your Windows installation experience. This repository contains the WiX Toolset code itself.
10 10
11# Developing WiX 11If you're new to WiX, check out our [Quick Start](https://docs.firegiant.com/quick-start/) to build your first installation package in just a few minutes.
12 12
13## Prerequisites
14 13
15- A command line Git client that is in the system path 14## Open Source Maintenance Fee
16- Visual Studio 2022 (17.8.2 or higher) with the following installed: 15
16<a href="https://opensourcemaintenancefee.org/"><img src='https://github.com/wixtoolset/.github/blob/master/profile/images/osmf-logo-square-dark.png' height='146' align='right' /></a>
17
18To ensure the long-term sustainability of this project, use of the WiX Toolset requires an [Open Source Maintenance Fee](https://opensourcemaintenancefee.org). While the source code is freely available under the terms of the [LICENSE](./LICENSE.TXT), all other aspects of the project--including opening or commenting on issues, participating in discussions and downloading releases--require [adherence to the Maintenance Fee](./OSMFEULA.txt).
19
20In short, if you use this project to generate revenue, the [Maintenance Fee is required](./OSMFEULA.txt).
21
22To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset).
23
24
25## Developing WiX
26
27### Prerequisites
28
29Before building the WiX Toolset, ensure you have Visual Studio 2022 (17.8.2 or higher) with the following installed:
17 30
18| Workloads | 31| Workloads |
19| :-------- | 32| :-------- |
@@ -32,26 +45,26 @@ This repository contains the WiX Toolset codebase.
32| MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) | 45| MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) |
33| Git for Windows | 46| Git for Windows |
34 47
35- [Download the latest nuget.exe command-line tool](https://www.nuget.org/downloads) and put it in a directory on the path. 48Also, download the latest [nuget.exe command-line tool](https://www.nuget.org/downloads) and place it in a directory on your path.
36 49
37##### Getting started: 50#### Getting started:
38 51
39* [Fork the WiX repository](https://github.com/wixtoolset/wix/fork) 52* [Fork the WiX repository](https://github.com/wixtoolset/wix/fork)
40 into your own GitHub repository 53 into your own GitHub repository
41* Clone the WiX repository from your fork (`git clone https://github.com/yourdomain/wix.git`) 54* Clone the WiX repository from your fork (`git clone https://github.com/yourdomain/wix.git`)
42 into the directory of your choice 55 into the directory of your choice
43 56
44##### To build the WiX toolset: 57#### To build the WiX toolset:
45 58
46 * Start a VS2022 'Developer Command Prompt' 59 * Start a VS2022 'Developer Command Prompt'
47 * Change directory to the root of the cloned repository 60 * Change directory to the root of the cloned repository
48 * Issue the command `devbuild` (or `devbuild release` if you want to create a release version) 61 * Issue the command `devbuild` (or `devbuild release` if you want to create a release version)
49 62
50 ##### Executing your newly built WiX toolset 63#### Executing your newly built WiX toolset
51 64
52 * `build\wix\Debug\publish\wix\wix --help` (Change `Debug` to `Release` if you built in release mode) 65 * `build\wix\Debug\publish\wix\wix --help` (Change `Debug` to `Release` if you built in release mode)
53 66
54 ##### Pull request expectations 67#### Pull request expectations
55 68
56 * Pick an [outstanding WiX issue](https://github.com/wixtoolset/issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) (or [create a new one](https://github.com/wixtoolset/issues/issues/new/choose)). Add a comment requesting that you be assigned to the issue. Wait for confirmation. 69 * Pick an [outstanding WiX issue](https://github.com/wixtoolset/issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) (or [create a new one](https://github.com/wixtoolset/issues/issues/new/choose)). Add a comment requesting that you be assigned to the issue. Wait for confirmation.
57 * To create a pull request, [fork a new branch](https://github.com/wixtoolset/wix/fork) from the `main` branch 70 * To create a pull request, [fork a new branch](https://github.com/wixtoolset/wix/fork) from the `main` branch
@@ -60,3 +73,10 @@ This repository contains the WiX Toolset codebase.
60 * If the `main` branch has changed since you created your branch, rebase to the latest updates. 73 * If the `main` branch has changed since you created your branch, rebase to the latest updates.
61 * If needed (ie, you squashed or rebased), do a force push of your branch 74 * If needed (ie, you squashed or rebased), do a force push of your branch
62 * Create a pull request with your branch against the WiX repository. 75 * Create a pull request with your branch against the WiX repository.
76
77## Additional information
78
79* Web site: https://www.firegiant.com/wixtoolset/
80* Documentation [WiX Documentation](https://docs.firegiant.com/wixtoolset/)
81* Issue Tracker: [GitHub Issues](https://github.com/wixtoolset/issues/issues)
82* Discussions: [WiX Toolset Discussions](https://github.com/orgs/wixtoolset/discussions)