Skip to content

Commit

Permalink
NuGet package readmes (4/n)
Browse files Browse the repository at this point in the history
  • Loading branch information
barnson committed Apr 4, 2024
1 parent 289c93d commit 8764d4e
Show file tree
Hide file tree
Showing 8 changed files with 48 additions and 0 deletions.
7 changes: 7 additions & 0 deletions src/ext/Bal/wixext/README.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand All @@ -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>
Expand Down
11 changes: 11 additions & 0 deletions src/ext/Bal/wixstdfn/README.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions src/ext/Bal/wixstdfn/wixstdfn.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -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)" />
Expand All @@ -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" />
Expand Down
12 changes: 12 additions & 0 deletions src/wix/WixToolset.Sdk/README.md
Original file line number Diff line number Diff line change
@@ -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/.
2 changes: 2 additions & 0 deletions src/wix/WixToolset.Sdk/WixToolset.Sdk.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down
7 changes: 7 additions & 0 deletions src/wix/pack-wix/README.md
Original file line number Diff line number Diff line change
@@ -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/.
2 changes: 2 additions & 0 deletions src/wix/pack-wix/pack-wix.nuspec
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down

0 comments on commit 8764d4e

Please sign in to comment.