diff options
| author | Rob Mensching <rob@firegiant.com> | 2025-04-04 13:33:48 -0700 |
|---|---|---|
| committer | Rob Mensching <rob@firegiant.com> | 2025-04-04 16:08:37 -0700 |
| commit | 90b1d345326fd05e701c82fa874590aeb6d1ee93 (patch) | |
| tree | e93f29d3a253b061ce1c7828252a4522f6deca11 /src/api/burn/WixToolset.BootstrapperApplicationApi | |
| parent | 532889b04d46ada4bfce65904f03c8f4db727368 (diff) | |
| download | wix-90b1d345326fd05e701c82fa874590aeb6d1ee93.tar.gz wix-90b1d345326fd05e701c82fa874590aeb6d1ee93.tar.bz2 wix-90b1d345326fd05e701c82fa874590aeb6d1ee93.zip | |
Update READMEs to include OSMF
Fixes 7862
Fixes 8974
Diffstat (limited to 'src/api/burn/WixToolset.BootstrapperApplicationApi')
| -rw-r--r-- | src/api/burn/WixToolset.BootstrapperApplicationApi/README.md | 37 | ||||
| -rw-r--r-- | src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec | 2 |
2 files changed, 39 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 | |||
| 3 | The `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 | |||
| 10 | 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]. | ||
| 11 | |||
| 12 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
| 13 | |||
| 14 | |||
| 15 | ## Getting started | ||
| 16 | |||
| 17 | BAFunctions 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 | |||
| 19 | The 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 | ||
