From 90b1d345326fd05e701c82fa874590aeb6d1ee93 Mon Sep 17 00:00:00 2001
From: Rob Mensching <rob@firegiant.com>
Date: Fri, 4 Apr 2025 13:33:48 -0700
Subject: Update READMEs to include OSMF

Fixes 7862
Fixes 8974
---
 .../README.md                                      | 37 ++++++++++++++++++++++
 .../WixToolset.BootstrapperApplicationApi.nuspec   |  2 ++
 src/api/burn/bextutil/README.md                    | 30 ++++++++++++++++++
 src/api/burn/bextutil/bextutil.nuspec              |  2 ++
 src/api/wix/WixToolset.Data/README.md              | 30 ++++++++++++++++++
 src/api/wix/WixToolset.Data/WixToolset.Data.csproj |  7 +++-
 src/api/wix/WixToolset.Extensibility/README.md     | 30 ++++++++++++++++++
 .../WixToolset.Extensibility.csproj                |  8 +++--
 8 files changed, 143 insertions(+), 3 deletions(-)
 create mode 100644 src/api/burn/WixToolset.BootstrapperApplicationApi/README.md
 create mode 100644 src/api/burn/bextutil/README.md
 create mode 100644 src/api/wix/WixToolset.Data/README.md
 create mode 100644 src/api/wix/WixToolset.Extensibility/README.md

(limited to 'src/api')

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 @@
+# WixToolset.BootstrapperApplicationApi - managed BootstrapperApplication API
+
+The `WixToolset.BootstrapperApplicationApi` package contains the SDK for building managed BootstrapperApplications.
+
+[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions]
+
+
+## Open Source Maintenance Fee
+
+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].
+
+To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset).
+
+
+## Getting started
+
+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.
+
+The best way to learn is via the samples at: https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions
+
+
+## Additional resources
+
+* [WiX Website][web]
+* [WiX Documentation][docs]
+* [WiX Issue Tracker][issues]
+* [WiX Discussions][discussions]
+
+
+[web]: https://www.firegiant.com/wixtoolset/
+[docs]: https://docs.firegiant.com/wixtoolset/
+[issues]: https://github.com/wixtoolset/issues/issues
+[discussions]: https://github.com/orgs/wixtoolset/discussions
+[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/
+[osmf]: https://opensourcemaintenancefee.org/
+[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT
+[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 @@
     <description>$description$</description>
     <authors>$authors$</authors>
     <icon>icon.png</icon>
+    <readme>README.md</readme>
     <license type="file">OSMFEULA.txt</license>
     <requireLicenseAcceptance>true</requireLicenseAcceptance>
     <tags>$packageTags$</tags>
@@ -25,6 +26,7 @@
   <files>
     <file src="$eulaTxt$" />
     <file src="$iconPng$" />
+    <file src="$projectFolder$\README.md" />
 
     <file src="$projectFolder$\build\WixToolset.BootstrapperApplicationApi.props" target="build\" />
 
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 @@
+# WixToolset.BootstrapperExtensionApi - extend WiX Bootstrapper Engine
+
+The `WixToolset.BootstrapperExtensionApi` package contains the SDK for extending the WiX Bootstrapper Engine, better known as "burn".
+
+[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions]
+
+
+## Open Source Maintenance Fee
+
+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].
+
+To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset).
+
+
+## Additional resources
+
+* [WiX Website][web]
+* [WiX Documentation][docs]
+* [WiX Issue Tracker][issues]
+* [WiX Discussions][discussions]
+
+
+[web]: https://www.firegiant.com/wixtoolset/
+[docs]: https://docs.firegiant.com/wixtoolset/
+[issues]: https://github.com/wixtoolset/issues/issues
+[discussions]: https://github.com/orgs/wixtoolset/discussions
+[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/
+[osmf]: https://opensourcemaintenancefee.org/
+[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT
+[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 @@
     <description>$description$</description>
     <authors>$authors$</authors>
     <icon>icon.png</icon>
+    <readme>README.md</readme>
     <license type="file">OSMFEULA.txt</license>
     <requireLicenseAcceptance>true</requireLicenseAcceptance>
     <tags>$packageTags$</tags>
@@ -21,6 +22,7 @@
   <files>
     <file src="$eulaTxt$" />
     <file src="$iconPng$" />
+    <file src="$projectFolder$\README.md" />
     <file src="$projectFolder$\build\$id$.props" target="build\" />
     <file src="$projectFolder$\inc\*" target="build\native\include" />
     <file src="$projectFolder$\..\inc\BootstrapperExtensionTypes.h" target="build\native\include" />
diff --git a/src/api/wix/WixToolset.Data/README.md b/src/api/wix/WixToolset.Data/README.md
new file mode 100644
index 00000000..192e7993
--- /dev/null
+++ b/src/api/wix/WixToolset.Data/README.md
@@ -0,0 +1,30 @@
+# WixToolset.Data - fundamental data types for the WiX Toolset
+
+The `WixToolset.Data` package provides the fundamental data types used throughout the WiX Toolset.
+
+[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions]
+
+
+## Open Source Maintenance Fee
+
+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].
+
+To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset).
+
+
+## Additional resources
+
+* [WiX Website][web]
+* [WiX Documentation][docs]
+* [WiX Issue Tracker][issues]
+* [WiX Discussions][discussions]
+
+
+[web]: https://www.firegiant.com/wixtoolset/
+[docs]: https://docs.firegiant.com/wixtoolset/
+[issues]: https://github.com/wixtoolset/issues/issues
+[discussions]: https://github.com/orgs/wixtoolset/discussions
+[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/
+[osmf]: https://opensourcemaintenancefee.org/
+[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT
+[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt
diff --git a/src/api/wix/WixToolset.Data/WixToolset.Data.csproj b/src/api/wix/WixToolset.Data/WixToolset.Data.csproj
index e2d71e87..257b9415 100644
--- a/src/api/wix/WixToolset.Data/WixToolset.Data.csproj
+++ b/src/api/wix/WixToolset.Data/WixToolset.Data.csproj
@@ -6,14 +6,19 @@
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net472</TargetFrameworks>
     <LangVersion>7.3</LangVersion>
-    <Description>WiX Toolset Data</Description>
     <DebugType>embedded</DebugType>
+    <Description>WiX Toolset Data</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <CreateDocumentationFile>true</CreateDocumentationFile>
     <!-- TODO: This shouldn't be ignored because this is public-facing -->
     <NoWarn>$(NoWarn);CS1591</NoWarn>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup>
     <PackageReference Include="System.IO.Compression" />
   </ItemGroup>
diff --git a/src/api/wix/WixToolset.Extensibility/README.md b/src/api/wix/WixToolset.Extensibility/README.md
new file mode 100644
index 00000000..62dee501
--- /dev/null
+++ b/src/api/wix/WixToolset.Extensibility/README.md
@@ -0,0 +1,30 @@
+# WixToolset.Extensibility - extensibility interfaces for the WiX Toolset
+
+The `WixToolset.Extensibility` package provides the interfaces and base classes WiX Extensions implement to extend the WiX Toolset.
+
+[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions]
+
+
+## Open Source Maintenance Fee
+
+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].
+
+To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset).
+
+
+## Additional resources
+
+* [WiX Website][web]
+* [WiX Documentation][docs]
+* [WiX Issue Tracker][issues]
+* [WiX Discussions][discussions]
+
+
+[web]: https://www.firegiant.com/wixtoolset/
+[docs]: https://docs.firegiant.com/wixtoolset/
+[issues]: https://github.com/wixtoolset/issues/issues
+[discussions]: https://github.com/orgs/wixtoolset/discussions
+[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/
+[osmf]: https://opensourcemaintenancefee.org/
+[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT
+[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt
diff --git a/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj b/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj
index 86ee754d..f0938b6f 100644
--- a/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj
+++ b/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj
@@ -5,13 +5,17 @@
   <PropertyGroup>
     <TargetFrameworks>netstandard2.0</TargetFrameworks>
     <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net472</TargetFrameworks>
-    <Title>WiX Toolset Extensibility</Title>
-    <Description></Description>
     <DebugType>embedded</DebugType>
+    <Description>WiX Toolset Extensibility</Description>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <CreateDocumentationFile>true</CreateDocumentationFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\WixToolset.Data\WixToolset.Data.csproj" />
   </ItemGroup>
-- 
cgit v1.2.3-55-g6feb