@joebigelow / wix / commits / ad78f1ba

NuGet package readmes (4/n)

See https://github.com/wixtoolset/issues/issues/7862.

Bob Arnson committed Apr 3, 2024 at 18:07 UTC ad78f1ba6693d2603b3465637148a58929b4f680
8 files changed +54
src/ext/Bal/wixext/README.md new
+7
@@ -0,0 +1,7 @@
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
src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj
+5
@@ -7,6 +7,7 @@
7 <RootNamespace>WixToolset.BootstrapperApplications</RootNamespace>
8 <Description>WiX Toolset BootstrapperApplications extension</Description>
9 <Title>WiX Toolset BootstrapperApplications extension</Title>
10 + <PackageReadmeFile>README.md</PackageReadmeFile>
11 <DebugType>embedded</DebugType>
12 </PropertyGroup>
13
@@ -16,6 +17,10 @@
17 <EmbeddedResource Include="$(OutputPath)..\bas.wixlib" />
18 </ItemGroup>
19
20 + <ItemGroup>
21 + <None Include="README.md" Pack="true" PackagePath="\" />
22 + </ItemGroup>
23 +
24 <ItemGroup Condition=" '$(NCrunch)'=='' ">
25 <ProjectReference Include="..\wixlib\bas.wixproj" ReferenceOutputAssembly="false" SkipGetTargetFrameworkProperties="true" />
26 </ItemGroup>
src/ext/Bal/wixstdfn/README.md new
+11
@@ -0,0 +1,11 @@
1 +# WixToolset.WixStandardBootstrapperApplicationFunctionApi
2 +
3 +WixToolset.WixStandardBootstrapperApplicationFunctionApi contains the SDK for building **BAFunctions** extensions for WixStdBA, the WiX Standard Bootstrapper Application for Burn bootstrapper bundles.
4 +
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.
6 +
7 +## Sources
8 +https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/wixstdfn
9 +
10 +## Samples
11 +https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions
src/ext/Bal/wixstdfn/wixstdfn.nuspec
+2
@@ -12,6 +12,7 @@
12 <copyright>$copyright$</copyright>
13 <projectUrl>$projectUrl$</projectUrl>
14 <repository type="$repositorytype$" url="$repositoryurl$" commit="$repositorycommit$" />
15 + <readme>README.md</readme>
16 <dependencies>
17 <group targetFramework="Native">
18 <dependency id="WixToolset.BootstrapperApplicationApi" version="[$version$,6)" />
@@ -21,6 +22,7 @@
22 </metadata>
23
24 <files>
25 + <file src="$projectFolder$\README.md" />
26 <file src="$projectFolder$\build\$id$.props" target="build\" />
27 <file src="$projectFolder$\..\..\..\internal\images\wix.png" />
28 <file src="$projectFolder$\inc\*" target="lib\native\include" />
src/wix/WixToolset.Sdk/README.md new
+12
@@ -0,0 +1,12 @@
1 +# WixToolset.Sdk
2 +
3 +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:
4 +
5 +```xml
6 +<Project Sdk="WixToolset.Sdk/5.0.0">
7 +</Project>
8 +```
9 +
10 +For more information about WiX as an MSBuild SDK, see https://wixtoolset.org/docs/intro/#msbuild.
11 +
12 +For more information about WiX targets, properties, and items, see https://wixtoolset.org/docs/tools/msbuild/.
src/wix/WixToolset.Sdk/WixToolset.Sdk.csproj
+5
@@ -5,11 +5,16 @@
5 <PropertyGroup>
6 <TargetFramework>net6.0</TargetFramework>
7 <Description>WiX Toolset MSBuild integration</Description>
8 + <PackageReadmeFile>README.md</PackageReadmeFile>
9 <PublishDir>$(PublishRoot)WixToolset.Sdk\</PublishDir>
10 <NuspecFile>$(MSBuildThisFileName).nuspec</NuspecFile>
11 <NuspecBasePath>$(PublishDir)</NuspecBasePath>
12 </PropertyGroup>
13
14 + <ItemGroup>
15 + <None Include="README.md" Pack="true" PackagePath="\" />
16 + </ItemGroup>
17 +
18 <ItemGroup>
19 <Content Include="build\$(MSBuildThisFileName).targets" CopyToOutputDirectory="PreserveNewest" />
20 <Content Include="tools\WixToolset.Signing.props" CopyToOutputDirectory="PreserveNewest" />
src/wix/pack-wix/README.md new
+7
@@ -0,0 +1,7 @@
1 +# wix
2 +
3 +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.
4 +
5 +To install WiX as a .NET tool or upgrade to a later version, see https://wixtoolset.org/docs/intro/#nettool.
6 +
7 +To read about available commands and switches, see https://wixtoolset.org/docs/tools/wixexe/.
src/wix/pack-wix/pack-wix.csproj
+5
@@ -7,7 +7,12 @@
7 <IncludeBuildOutput>false</IncludeBuildOutput>
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>
10 + <PackageReadmeFile>README.md</PackageReadmeFile>
11 <PackageId>wix</PackageId>
12 <NuspecBasePath>$(OutputPath)publish\wix\</NuspecBasePath>
13 </PropertyGroup>
14 +
15 + <ItemGroup>
16 + <None Include="README.md" Pack="true" PackagePath="\" />
17 + </ItemGroup>
18 </Project>