aboutsummaryrefslogtreecommitdiff
path: root/src/api/burn
diff options
context:
space:
mode:
Diffstat (limited to 'src/api/burn')
-rw-r--r--src/api/burn/WixToolset.BootstrapperApplicationApi/README.md37
-rw-r--r--src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec2
-rw-r--r--src/api/burn/bextutil/README.md30
-rw-r--r--src/api/burn/bextutil/bextutil.nuspec2
4 files changed, 71 insertions, 0 deletions
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md b/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md
new file mode 100644
index 00000000..eeedbf9f
--- /dev/null
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md
@@ -0,0 +1,37 @@
1# WixToolset.BootstrapperApplicationApi - managed BootstrapperApplication API
2
3The `WixToolset.BootstrapperApplicationApi` package contains the SDK for building managed BootstrapperApplications.
4
5[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions]
6
7
8## Open Source Maintenance Fee
9
10To 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].
11
12To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset).
13
14
15## Getting started
16
17BAFunctions are native-code DLLs (typically written in C++) that let you supplement the behavior of WixStdBA, rather than writing an entirely new BA to tweak existing BA behavior.
18
19The best way to learn is via the samples at: https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions
20
21
22## Additional resources
23
24* [WiX Website][web]
25* [WiX Documentation][docs]
26* [WiX Issue Tracker][issues]
27* [WiX Discussions][discussions]
28
29
30[web]: https://www.firegiant.com/wixtoolset/
31[docs]: https://docs.firegiant.com/wixtoolset/
32[issues]: https://github.com/wixtoolset/issues/issues
33[discussions]: https://github.com/orgs/wixtoolset/discussions
34[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/
35[osmf]: https://opensourcemaintenancefee.org/
36[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT
37[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec b/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec
index 63acc895..73fef99b 100644
--- a/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec
+++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec
@@ -7,6 +7,7 @@
7 <description>$description$</description> 7 <description>$description$</description>
8 <authors>$authors$</authors> 8 <authors>$authors$</authors>
9 <icon>icon.png</icon> 9 <icon>icon.png</icon>
10 <readme>README.md</readme>
10 <license type="file">OSMFEULA.txt</license> 11 <license type="file">OSMFEULA.txt</license>
11 <requireLicenseAcceptance>true</requireLicenseAcceptance> 12 <requireLicenseAcceptance>true</requireLicenseAcceptance>
12 <tags>$packageTags$</tags> 13 <tags>$packageTags$</tags>
@@ -25,6 +26,7 @@
25 <files> 26 <files>
26 <file src="$eulaTxt$" /> 27 <file src="$eulaTxt$" />
27 <file src="$iconPng$" /> 28 <file src="$iconPng$" />
29 <file src="$projectFolder$\README.md" />
28 30
29 <file src="$projectFolder$\build\WixToolset.BootstrapperApplicationApi.props" target="build\" /> 31 <file src="$projectFolder$\build\WixToolset.BootstrapperApplicationApi.props" target="build\" />
30 32
diff --git a/src/api/burn/bextutil/README.md b/src/api/burn/bextutil/README.md
new file mode 100644
index 00000000..cee7e98c
--- /dev/null
+++ b/src/api/burn/bextutil/README.md
@@ -0,0 +1,30 @@
1# WixToolset.BootstrapperExtensionApi - extend WiX Bootstrapper Engine
2
3The `WixToolset.BootstrapperExtensionApi` package contains the SDK for extending the WiX Bootstrapper Engine, better known as "burn".
4
5[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions]
6
7
8## Open Source Maintenance Fee
9
10To 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].
11
12To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset).
13
14
15## Additional resources
16
17* [WiX Website][web]
18* [WiX Documentation][docs]
19* [WiX Issue Tracker][issues]
20* [WiX Discussions][discussions]
21
22
23[web]: https://www.firegiant.com/wixtoolset/
24[docs]: https://docs.firegiant.com/wixtoolset/
25[issues]: https://github.com/wixtoolset/issues/issues
26[discussions]: https://github.com/orgs/wixtoolset/discussions
27[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/
28[osmf]: https://opensourcemaintenancefee.org/
29[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT
30[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt
diff --git a/src/api/burn/bextutil/bextutil.nuspec b/src/api/burn/bextutil/bextutil.nuspec
index f790e0b8..065b72a3 100644
--- a/src/api/burn/bextutil/bextutil.nuspec
+++ b/src/api/burn/bextutil/bextutil.nuspec
@@ -7,6 +7,7 @@
7 <description>$description$</description> 7 <description>$description$</description>
8 <authors>$authors$</authors> 8 <authors>$authors$</authors>
9 <icon>icon.png</icon> 9 <icon>icon.png</icon>
10 <readme>README.md</readme>
10 <license type="file">OSMFEULA.txt</license> 11 <license type="file">OSMFEULA.txt</license>
11 <requireLicenseAcceptance>true</requireLicenseAcceptance> 12 <requireLicenseAcceptance>true</requireLicenseAcceptance>
12 <tags>$packageTags$</tags> 13 <tags>$packageTags$</tags>
@@ -21,6 +22,7 @@
21 <files> 22 <files>
22 <file src="$eulaTxt$" /> 23 <file src="$eulaTxt$" />
23 <file src="$iconPng$" /> 24 <file src="$iconPng$" />
25 <file src="$projectFolder$\README.md" />
24 <file src="$projectFolder$\build\$id$.props" target="build\" /> 26 <file src="$projectFolder$\build\$id$.props" target="build\" />
25 <file src="$projectFolder$\inc\*" target="build\native\include" /> 27 <file src="$projectFolder$\inc\*" target="build\native\include" />
26 <file src="$projectFolder$\..\inc\BootstrapperExtensionTypes.h" target="build\native\include" /> 28 <file src="$projectFolder$\..\inc\BootstrapperExtensionTypes.h" target="build\native\include" />