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/ext/Bal | |
| 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/ext/Bal')
| -rw-r--r-- | src/ext/Bal/README.md | 60 | ||||
| -rw-r--r-- | src/ext/Bal/wixext/README.md | 7 | ||||
| -rw-r--r-- | src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj | 2 | ||||
| -rw-r--r-- | src/ext/Bal/wixstdfn/README.md | 38 | ||||
| -rw-r--r-- | src/ext/Bal/wixstdfn/wixstdfn.nuspec | 2 |
5 files changed, 92 insertions, 17 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 | ||
diff --git a/src/ext/Bal/wixext/README.md b/src/ext/Bal/wixext/README.md deleted file mode 100644 index a986cb0e..00000000 --- a/src/ext/Bal/wixext/README.md +++ /dev/null | |||
| @@ -1,7 +0,0 @@ | |||
| 1 | # WixToolset.BootstrapperApplications | ||
| 2 | |||
| 3 | WixToolset.BootstrapperApplications is a WiX extension that provides the WiX bootstrapper applications: | ||
| 4 | |||
| 5 | - WixStdBA ([WixStandardBootstrapperApplication](https://wixtoolset.org/docs/schema/bal/wixstandardbootstrapperapplication/)), a bootstrapper application with support for custom themes | ||
| 6 | - WixIuiBA ([WixInternalUIBootstrapperApplication](https://wixtoolset.org/docs/schema/bal/wixinternaluibootstrapperapplication/)), a bootstrapper application for showing internal UI of Windows Installer packages | ||
| 7 | - WixPreqBA ([WixPrerequisiteBootstrapperApplication](https://wixtoolset.org/docs/schema/bal/wixprerequisitebootstrapperapplication/)), a secondary bootstrapper application for bootstrapping the prerequisites needed for a primary bootstrapper application | ||
diff --git a/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj b/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj index de32ff4d..adc6a86f 100644 --- a/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj +++ b/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj | |||
| @@ -18,7 +18,7 @@ | |||
| 18 | </ItemGroup> | 18 | </ItemGroup> |
| 19 | 19 | ||
| 20 | <ItemGroup> | 20 | <ItemGroup> |
| 21 | <None Include="README.md" Pack="true" PackagePath="\" /> | 21 | <None Include="..\README.md" Pack="true" PackagePath="\" /> |
| 22 | </ItemGroup> | 22 | </ItemGroup> |
| 23 | 23 | ||
| 24 | <ItemGroup Condition=" '$(NCrunch)'=='' "> | 24 | <ItemGroup Condition=" '$(NCrunch)'=='' "> |
diff --git a/src/ext/Bal/wixstdfn/README.md b/src/ext/Bal/wixstdfn/README.md index 0977ff42..4aef768e 100644 --- a/src/ext/Bal/wixstdfn/README.md +++ b/src/ext/Bal/wixstdfn/README.md | |||
| @@ -1,11 +1,37 @@ | |||
| 1 | # WixToolset.WixStandardBootstrapperApplicationFunctionApi | 1 | # WixToolset.WixStandardBootstrapperApplicationFunctionApi - extend WiX Standard Bootstrapper Application |
| 2 | 2 | ||
| 3 | WixToolset.WixStandardBootstrapperApplicationFunctionApi contains the SDK for building **BAFunctions** extensions for WixStdBA, the WiX Standard Bootstrapper Application for Burn bootstrapper bundles. | 3 | The `WixToolset.WixStandardBootstrapperApplicationFunctionApi` package contains the SDK for building **BAFunctions** extensions for WixStdBA, the WiX Standard Bootstrapper Application for Burn bootstrapper bundles. |
| 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 | ||
| 4 | 16 | ||
| 5 | 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. | 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. |
| 6 | 18 | ||
| 7 | ## Sources | 19 | The best way to learn is via the samples at: https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions |
| 8 | https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/wixstdfn | 20 | |
| 21 | |||
| 22 | ## Additional resources | ||
| 23 | |||
| 24 | * [WiX Website][web] | ||
| 25 | * [WiX Documentation][docs] | ||
| 26 | * [WiX Issue Tracker][issues] | ||
| 27 | * [WiX Discussions][discussions] | ||
| 28 | |||
| 9 | 29 | ||
| 10 | ## Samples | 30 | [web]: https://www.firegiant.com/wixtoolset/ |
| 11 | https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions | 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/ext/Bal/wixstdfn/wixstdfn.nuspec b/src/ext/Bal/wixstdfn/wixstdfn.nuspec index 86860b67..d4b6e104 100644 --- a/src/ext/Bal/wixstdfn/wixstdfn.nuspec +++ b/src/ext/Bal/wixstdfn/wixstdfn.nuspec | |||
| @@ -7,13 +7,13 @@ | |||
| 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> |
| 13 | <copyright>$copyright$</copyright> | 14 | <copyright>$copyright$</copyright> |
| 14 | <projectUrl>$projectUrl$</projectUrl> | 15 | <projectUrl>$projectUrl$</projectUrl> |
| 15 | <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" /> | 16 | <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" /> |
| 16 | <readme>README.md</readme> | ||
| 17 | <dependencies> | 17 | <dependencies> |
| 18 | <group targetFramework="Native"> | 18 | <group targetFramework="Native"> |
| 19 | <dependency id="WixToolset.BootstrapperApplicationApi" version="[$version$,$nextmajorversion$)" /> | 19 | <dependency id="WixToolset.BootstrapperApplicationApi" version="[$version$,$nextmajorversion$)" /> |
