From 8764d4e99143d1290313293205a9b4b6e3c3ddf0 Mon Sep 17 00:00:00 2001
From: Bob Arnson <bob@firegiant.com>
Date: Wed, 3 Apr 2024 18:07:08 -0400
Subject: [PATCH] NuGet package readmes (4/n)

See https://github.com/wixtoolset/issues/issues/7862.
---
 src/ext/Bal/wixext/README.md                         |  7 +++++++
 ...WixToolset.BootstrapperApplications.wixext.csproj |  5 +++++
 src/ext/Bal/wixstdfn/README.md                       | 11 +++++++++++
 src/ext/Bal/wixstdfn/wixstdfn.nuspec                 |  2 ++
 src/wix/WixToolset.Sdk/README.md                     | 12 ++++++++++++
 src/wix/WixToolset.Sdk/WixToolset.Sdk.nuspec         |  2 ++
 src/wix/pack-wix/README.md                           |  7 +++++++
 src/wix/pack-wix/pack-wix.nuspec                     |  2 ++
 8 files changed, 48 insertions(+)
 create mode 100644 src/ext/Bal/wixext/README.md
 create mode 100644 src/ext/Bal/wixstdfn/README.md
 create mode 100644 src/wix/WixToolset.Sdk/README.md
 create mode 100644 src/wix/pack-wix/README.md

diff --git a/src/ext/Bal/wixext/README.md b/src/ext/Bal/wixext/README.md
new file mode 100644
index 000000000..a986cb0ee
--- /dev/null
+++ b/src/ext/Bal/wixext/README.md
@@ -0,0 +1,7 @@
+# WixToolset.BootstrapperApplications
+
+WixToolset.BootstrapperApplications is a WiX extension that provides the WiX bootstrapper applications:
+
+- WixStdBA ([WixStandardBootstrapperApplication](https://wixtoolset.org/docs/schema/bal/wixstandardbootstrapperapplication/)), a bootstrapper application with support for custom themes
+- WixIuiBA ([WixInternalUIBootstrapperApplication](https://wixtoolset.org/docs/schema/bal/wixinternaluibootstrapperapplication/)), a bootstrapper application for showing internal UI of Windows Installer packages
+- 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 3dd8d306e..de32ff4d0 100644
--- a/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj
+++ b/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj
@@ -7,6 +7,7 @@
     <RootNamespace>WixToolset.BootstrapperApplications</RootNamespace>
     <Description>WiX Toolset BootstrapperApplications extension</Description>
     <Title>WiX Toolset BootstrapperApplications extension</Title>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <DebugType>embedded</DebugType>
   </PropertyGroup>
 
@@ -16,6 +17,10 @@
     <EmbeddedResource Include="$(OutputPath)..\bas.wixlib" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <ItemGroup Condition=" '$(NCrunch)'=='' ">
     <ProjectReference Include="..\wixlib\bas.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true" />
   </ItemGroup>
diff --git a/src/ext/Bal/wixstdfn/README.md b/src/ext/Bal/wixstdfn/README.md
new file mode 100644
index 000000000..0977ff428
--- /dev/null
+++ b/src/ext/Bal/wixstdfn/README.md
@@ -0,0 +1,11 @@
+# WixToolset.WixStandardBootstrapperApplicationFunctionApi
+
+WixToolset.WixStandardBootstrapperApplicationFunctionApi contains the SDK for building **BAFunctions** extensions for WixStdBA, the WiX Standard Bootstrapper Application for Burn bootstrapper bundles.
+
+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.
+
+## Sources
+https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/wixstdfn
+
+## Samples
+https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions
diff --git a/src/ext/Bal/wixstdfn/wixstdfn.nuspec b/src/ext/Bal/wixstdfn/wixstdfn.nuspec
index 46a5de8c8..4b8e0e137 100644
--- a/src/ext/Bal/wixstdfn/wixstdfn.nuspec
+++ b/src/ext/Bal/wixstdfn/wixstdfn.nuspec
@@ -12,6 +12,7 @@
     <copyright>$copyright$</copyright>
     <projectUrl>$projectUrl$</projectUrl>
     <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" />
+    <readme>README.md</readme>
     <dependencies>
       <group targetFramework="Native">
         <dependency id="WixToolset.BootstrapperApplicationApi" version="[$version$,6)" />
@@ -21,6 +22,7 @@
   </metadata>
 
   <files>
+    <file src="README.md" />
     <file src="$projectFolder$\build\$id$.props" target="build\" />
     <file src="$projectFolder$\..\..\..\internal\images\wix.png" />
     <file src="$projectFolder$\inc\*" target="lib\native\include" />
diff --git a/src/wix/WixToolset.Sdk/README.md b/src/wix/WixToolset.Sdk/README.md
new file mode 100644
index 000000000..29448714c
--- /dev/null
+++ b/src/wix/WixToolset.Sdk/README.md
@@ -0,0 +1,12 @@
+# WixToolset.Sdk
+
+The `WixToolset.Sdk` package provides the WiX Toolset as an MSBuild SDK for both .NET (v6 or later) and .NET Framework (v4.7.2 or later). SDK-style projects have smart defaults that make for simple .wixproj project authoring. For example, here's a minimal .wixproj that builds an MSI from the .wxs source files in the project directory:
+
+```xml
+<Project Sdk="WixToolset.Sdk/4.0.5">
+</Project>
+```
+
+For more information about WiX as an MSBuild SDK, see https://wixtoolset.org/docs/intro/#msbuild.
+
+For more information about WiX targets, properties, and items, see https://wixtoolset.org/docs/tools/msbuild/.
diff --git a/src/wix/WixToolset.Sdk/WixToolset.Sdk.nuspec b/src/wix/WixToolset.Sdk/WixToolset.Sdk.nuspec
index 1f4e1cb35..cf0191893 100644
--- a/src/wix/WixToolset.Sdk/WixToolset.Sdk.nuspec
+++ b/src/wix/WixToolset.Sdk/WixToolset.Sdk.nuspec
@@ -12,12 +12,14 @@
     <copyright>$copyright$</copyright>
     <projectUrl>$projectUrl$</projectUrl>
     <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" />
+    <readme>README.md</readme>
     <packageTypes>
       <packageType name="MSBuildSdk" />
     </packageTypes>
   </metadata>
 
   <files>
+    <file src="README.md" />
     <file src="$projectFolder$\..\..\internal\images\wix.png" />
     <file src="build\**\*" target="build" />
     <file src="Sdk\**\*" target="Sdk" />
diff --git a/src/wix/pack-wix/README.md b/src/wix/pack-wix/README.md
new file mode 100644
index 000000000..95ac7c820
--- /dev/null
+++ b/src/wix/pack-wix/README.md
@@ -0,0 +1,7 @@
+# wix
+
+The `wix` package provides the WiX Toolset as a .NET Tool, perfect for your command-line packaging pleasure. Version 6 or later of the .NET SDK is required.
+
+To install WiX as a .NET tool or upgrade to a later version, see https://wixtoolset.org/docs/intro/#nettool.
+
+To read about available commands and switches, see https://wixtoolset.org/docs/tools/wixexe/.
diff --git a/src/wix/pack-wix/pack-wix.nuspec b/src/wix/pack-wix/pack-wix.nuspec
index 8ecca0f20..52c821b1a 100644
--- a/src/wix/pack-wix/pack-wix.nuspec
+++ b/src/wix/pack-wix/pack-wix.nuspec
@@ -12,12 +12,14 @@
     <copyright>$copyright$</copyright>
     <projectUrl>$projectUrl$</projectUrl>
     <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" />
+    <readme>README.md</readme>
     <packageTypes>
       <packageType name="DotnetTool" />
     </packageTypes>
   </metadata>
 
   <files>
+    <file src="README.md" />
     <file src="$projectFolder$\DotnetToolSettings.xml" target="tools\net6.0\any" />
     <file src="$projectFolder$\..\..\internal\images\wix.png" />
     <file src="**" target="tools\net6.0\any" exclude="**\*.xml;**\WixToolset.Core.Native.targets" />