diff options
Diffstat (limited to '')
-rw-r--r-- | src/ext/Bal/README.md | 60 |
1 files changed, 58 insertions, 2 deletions
diff --git a/src/ext/Bal/README.md b/src/ext/Bal/README.md index 4a14b1a2..5e969c4f 100644 --- a/src/ext/Bal/README.md +++ b/src/ext/Bal/README.md | |||
@@ -1,2 +1,58 @@ | |||
1 | # WixToolset.BootstrapperApplications.wixext | 1 | # WixToolset.BootstrapperApplications.wixext - Bootstrapper Applications WiX Toolset Extension |
2 | WixToolset.BootstrapperApplications.wixext - Bootstrapper Applications WiX Toolset Extension | 2 | |
3 | This WiX Extension provides the standard BootstrapperApplications provided by the WiX Toolset. | ||
4 | |||
5 | - WixStdBA ([WixStandardBootstrapperApplication](https://docs.firegiant.com/wix/schema/bal/wixstandardbootstrapperapplication/)), a bootstrapper application with support for custom themes | ||
6 | - WixIuiBA ([WixInternalUIBootstrapperApplication](https://docs.firegiant.com/wix/schema/bal/wixinternaluibootstrapperapplication/)), a bootstrapper application for showing internal UI of Windows Installer packages | ||
7 | - WixPreqBA ([WixPrerequisiteBootstrapperApplication](https://docs.firegiant.com/wix/schema/bal/wixprerequisitebootstrapperapplication/)), a secondary bootstrapper application for bootstrapping the prerequisites needed for a primary bootstrapper application | ||
8 | |||
9 | [Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] | ||
10 | |||
11 | ## Open Source Maintenance Fee | ||
12 | |||
13 | To ensure the long-term sustainability of this project, users of this package who generate revenue must pay an [Open Source Maintenance Fee][osmf]. While the source code is freely available under the terms of the [LICENSE][license], this package and other aspects of the project require [adherence to the Open Source Maintenance Fee EULA][eula]. | ||
14 | |||
15 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
16 | |||
17 | |||
18 | ## Getting started | ||
19 | |||
20 | Add the WiX Extension as a PackageReference to your .wixproj: | ||
21 | |||
22 | ``` | ||
23 | <Project Sdk="WixToolset.Sdk/6.0.0"> | ||
24 | <ItemGroup> | ||
25 | <PackageReference Include="WixToolset.BootstrapperApplications.wixext" Version="6.0.0" /> | ||
26 | </ItemGroup> | ||
27 | </Project> | ||
28 | ``` | ||
29 | |||
30 | Then add the namespace and bootstrapper application of choice: | ||
31 | |||
32 | ``` | ||
33 | <Wix xmlns="http://wixtoolset.org/schemas/v4/wxs" | ||
34 | xmlns:bal="http://wixtoolset.org/schemas/v4/wxs/bal"> | ||
35 | <Bundle BundleId="AcmeCorp.Example" Name="Example Bundle" Version="0.0.0.1" Manufacturer="ACME Corporation"> | ||
36 | <BootstrapperApplication> | ||
37 | <bal:WixStandardBootstrapperApplication LicenseUrl="http://wixtoolset.org/about/license/" Theme="hyperlinkLicense" /> | ||
38 | </BootstrapperApplication> | ||
39 | </Bundle> | ||
40 | </Wix> | ||
41 | ``` | ||
42 | |||
43 | ## Additional resources | ||
44 | |||
45 | * [WiX Website][web] | ||
46 | * [WiX Documentation][docs] | ||
47 | * [WiX Issue Tracker][issues] | ||
48 | * [WiX Discussions][discussions] | ||
49 | |||
50 | |||
51 | [web]: https://www.firegiant.com/wixtoolset/ | ||
52 | [docs]: https://docs.firegiant.com/wixtoolset/ | ||
53 | [issues]: https://github.com/wixtoolset/issues/issues | ||
54 | [discussions]: https://github.com/orgs/wixtoolset/discussions | ||
55 | [sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ | ||
56 | [osmf]: https://opensourcemaintenancefee.org/ | ||
57 | [license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT | ||
58 | [eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt | ||