aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBob Arnson <bob@firegiant.com>2024-04-03 18:07:08 -0400
committerBob Arnson <github@bobs.org>2024-04-04 19:46:53 -0400
commitad78f1ba6693d2603b3465637148a58929b4f680 (patch)
tree56123baa98df0e8eecb5fd3ea70646dd28af89f0
parentba93485c940b0bae6e0b6a005fdd1819652f3984 (diff)
downloadwix-ad78f1ba6693d2603b3465637148a58929b4f680.tar.gz
wix-ad78f1ba6693d2603b3465637148a58929b4f680.tar.bz2
wix-ad78f1ba6693d2603b3465637148a58929b4f680.zip
NuGet package readmes (4/n)
See https://github.com/wixtoolset/issues/issues/7862.
-rw-r--r--src/ext/Bal/wixext/README.md7
-rw-r--r--src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj5
-rw-r--r--src/ext/Bal/wixstdfn/README.md11
-rw-r--r--src/ext/Bal/wixstdfn/wixstdfn.nuspec2
-rw-r--r--src/wix/WixToolset.Sdk/README.md12
-rw-r--r--src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj5
-rw-r--r--src/wix/pack-wix/README.md7
-rw-r--r--src/wix/pack-wix/pack-wix.csproj5
8 files changed, 54 insertions, 0 deletions
diff --git a/src/ext/Bal/wixext/README.md b/src/ext/Bal/wixext/README.md
new file mode 100644
index 00000000..a986cb0e
--- /dev/null
+++ b/src/ext/Bal/wixext/README.md
@@ -0,0 +1,7 @@
1# WixToolset.BootstrapperApplications
2
3WixToolset.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 3dd8d306..de32ff4d 100644
--- a/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj
+++ b/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj
@@ -7,6 +7,7 @@
7 <RootNamespace>WixToolset.BootstrapperApplications</RootNamespace> 7 <RootNamespace>WixToolset.BootstrapperApplications</RootNamespace>
8 <Description>WiX Toolset BootstrapperApplications extension</Description> 8 <Description>WiX Toolset BootstrapperApplications extension</Description>
9 <Title>WiX Toolset BootstrapperApplications extension</Title> 9 <Title>WiX Toolset BootstrapperApplications extension</Title>
10 <PackageReadmeFile>README.md</PackageReadmeFile>
10 <DebugType>embedded</DebugType> 11 <DebugType>embedded</DebugType>
11 </PropertyGroup> 12 </PropertyGroup>
12 13
@@ -16,6 +17,10 @@
16 <EmbeddedResource Include="$(OutputPath)..\bas.wixlib" /> 17 <EmbeddedResource Include="$(OutputPath)..\bas.wixlib" />
17 </ItemGroup> 18 </ItemGroup>
18 19
20 <ItemGroup>
21 <None Include="README.md" Pack="true" PackagePath="\" />
22 </ItemGroup>
23
19 <ItemGroup Condition=" '$(NCrunch)'=='' "> 24 <ItemGroup Condition=" '$(NCrunch)'=='' ">
20 <ProjectReference Include="..\wixlib\bas.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true" /> 25 <ProjectReference Include="..\wixlib\bas.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true" />
21 </ItemGroup> 26 </ItemGroup>
diff --git a/src/ext/Bal/wixstdfn/README.md b/src/ext/Bal/wixstdfn/README.md
new file mode 100644
index 00000000..0977ff42
--- /dev/null
+++ b/src/ext/Bal/wixstdfn/README.md
@@ -0,0 +1,11 @@
1# WixToolset.WixStandardBootstrapperApplicationFunctionApi
2
3WixToolset.WixStandardBootstrapperApplicationFunctionApi contains the SDK for building **BAFunctions** extensions for WixStdBA, the WiX Standard Bootstrapper Application for Burn bootstrapper bundles.
4
5BAFunctions 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
7## Sources
8https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/wixstdfn
9
10## Samples
11https://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 46a5de8c..1924431e 100644
--- a/src/ext/Bal/wixstdfn/wixstdfn.nuspec
+++ b/src/ext/Bal/wixstdfn/wixstdfn.nuspec
@@ -12,6 +12,7 @@
12 <copyright>$copyright$</copyright> 12 <copyright>$copyright$</copyright>
13 <projectUrl>$projectUrl$</projectUrl> 13 <projectUrl>$projectUrl$</projectUrl>
14 <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" /> 14 <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" />
15 <readme>README.md</readme>
15 <dependencies> 16 <dependencies>
16 <group targetFramework="Native"> 17 <group targetFramework="Native">
17 <dependency id="WixToolset.BootstrapperApplicationApi" version="[$version$,6)" /> 18 <dependency id="WixToolset.BootstrapperApplicationApi" version="[$version$,6)" />
@@ -21,6 +22,7 @@
21 </metadata> 22 </metadata>
22 23
23 <files> 24 <files>
25 <file src="$projectFolder$\README.md" />
24 <file src="$projectFolder$\build\$id$.props" target="build\" /> 26 <file src="$projectFolder$\build\$id$.props" target="build\" />
25 <file src="$projectFolder$\..\..\..\internal\images\wix.png" /> 27 <file src="$projectFolder$\..\..\..\internal\images\wix.png" />
26 <file src="$projectFolder$\inc\*" target="lib\native\include" /> 28 <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 00000000..6b139d9c
--- /dev/null
+++ b/src/wix/WixToolset.Sdk/README.md
@@ -0,0 +1,12 @@
1# WixToolset.Sdk
2
3The `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:
4
5```xml
6<Project Sdk="WixToolset.Sdk/5.0.0">
7</Project>
8```
9
10For more information about WiX as an MSBuild SDK, see https://wixtoolset.org/docs/intro/#msbuild.
11
12For more information about WiX targets, properties, and items, see https://wixtoolset.org/docs/tools/msbuild/.
diff --git a/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj b/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj
index 46ff4d80..2f9b33fd 100644
--- a/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj
+++ b/src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj
@@ -5,12 +5,17 @@
5 <PropertyGroup> 5 <PropertyGroup>
6 <TargetFramework>net6.0</TargetFramework> 6 <TargetFramework>net6.0</TargetFramework>
7 <Description>WiX Toolset MSBuild integration</Description> 7 <Description>WiX Toolset MSBuild integration</Description>
8 <PackageReadmeFile>README.md</PackageReadmeFile>
8 <PublishDir>$(PublishRoot)WixToolset.Sdk\</PublishDir> 9 <PublishDir>$(PublishRoot)WixToolset.Sdk\</PublishDir>
9 <NuspecFile>$(MSBuildThisFileName).nuspec</NuspecFile> 10 <NuspecFile>$(MSBuildThisFileName).nuspec</NuspecFile>
10 <NuspecBasePath>$(PublishDir)</NuspecBasePath> 11 <NuspecBasePath>$(PublishDir)</NuspecBasePath>
11 </PropertyGroup> 12 </PropertyGroup>
12 13
13 <ItemGroup> 14 <ItemGroup>
15 <None Include="README.md" Pack="true" PackagePath="\" />
16 </ItemGroup>
17
18 <ItemGroup>
14 <Content Include="build\$(MSBuildThisFileName).targets" CopyToOutputDirectory="PreserveNewest" /> 19 <Content Include="build\$(MSBuildThisFileName).targets" CopyToOutputDirectory="PreserveNewest" />
15 <Content Include="tools\WixToolset.Signing.props" CopyToOutputDirectory="PreserveNewest" /> 20 <Content Include="tools\WixToolset.Signing.props" CopyToOutputDirectory="PreserveNewest" />
16 <Content Include="tools\WixToolset.Signing.targets" CopyToOutputDirectory="PreserveNewest" /> 21 <Content Include="tools\WixToolset.Signing.targets" CopyToOutputDirectory="PreserveNewest" />
diff --git a/src/wix/pack-wix/README.md b/src/wix/pack-wix/README.md
new file mode 100644
index 00000000..95ac7c82
--- /dev/null
+++ b/src/wix/pack-wix/README.md
@@ -0,0 +1,7 @@
1# wix
2
3The `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.
4
5To install WiX as a .NET tool or upgrade to a later version, see https://wixtoolset.org/docs/intro/#nettool.
6
7To read about available commands and switches, see https://wixtoolset.org/docs/tools/wixexe/.
diff --git a/src/wix/pack-wix/pack-wix.csproj b/src/wix/pack-wix/pack-wix.csproj
index 092145f6..0a8dc89c 100644
--- a/src/wix/pack-wix/pack-wix.csproj
+++ b/src/wix/pack-wix/pack-wix.csproj
@@ -7,7 +7,12 @@
7 <IncludeBuildOutput>false</IncludeBuildOutput> 7 <IncludeBuildOutput>false</IncludeBuildOutput>
8 <Title>The WiX Toolset command-line interface.</Title> 8 <Title>The WiX Toolset command-line interface.</Title>
9 <Description>The WiX Toolset lets developers create installers for Windows. This package contains the WiX Toolset command-line interface.</Description> 9 <Description>The WiX Toolset lets developers create installers for Windows. This package contains the WiX Toolset command-line interface.</Description>
10 <PackageReadmeFile>README.md</PackageReadmeFile>
10 <PackageId>wix</PackageId> 11 <PackageId>wix</PackageId>
11 <NuspecBasePath>$(OutputPath)publish\wix\</NuspecBasePath> 12 <NuspecBasePath>$(OutputPath)publish\wix\</NuspecBasePath>
12 </PropertyGroup> 13 </PropertyGroup>
14
15 <ItemGroup>
16 <None Include="README.md" Pack="true" PackagePath="\" />
17 </ItemGroup>
13</Project> 18</Project>