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
---
 src/tools/WixToolset.Heat/README.md              | 30 ++++++++++++++++++++++++
 src/tools/WixToolset.Heat/WixToolset.Heat.nuspec |  2 ++
 2 files changed, 32 insertions(+)
 create mode 100644 src/tools/WixToolset.Heat/README.md

(limited to 'src/tools')

diff --git a/src/tools/WixToolset.Heat/README.md b/src/tools/WixToolset.Heat/README.md
new file mode 100644
index 00000000..7858da67
--- /dev/null
+++ b/src/tools/WixToolset.Heat/README.md
@@ -0,0 +1,30 @@
+# WixToolset.Heat - old harvesting tool from WiX v3
+
+The `WixToolset.Heat` package provides the (now deprecated) harvesting tools originally designed for WiX v3. The bulk of the functionality provided by this package has been eclipsed by the `Files` element. It is recommended to migrate to that new functionality or a custom solution.
+
+[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/tools/WixToolset.Heat/WixToolset.Heat.nuspec b/src/tools/WixToolset.Heat/WixToolset.Heat.nuspec
index 48e94797..f01faa04 100644
--- a/src/tools/WixToolset.Heat/WixToolset.Heat.nuspec
+++ b/src/tools/WixToolset.Heat/WixToolset.Heat.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>
@@ -18,6 +19,7 @@
   <files>
     <file src="$eulaTxt$" />
     <file src="$iconPng$" />
+    <file src="$projectFolder$\README.md" />
     <file src="$projectFolder$\$id$.targets" target="build" />
     <file src="tools\**\*" target="tools" />
   </files>
-- 
cgit v1.2.3-55-g6feb