diff options
author | Rob Mensching <rob@firegiant.com> | 2025-04-04 13:33:48 -0700 |
---|---|---|
committer | Rob Mensching <rob@firegiant.com> | 2025-04-04 16:08:37 -0700 |
commit | 90b1d345326fd05e701c82fa874590aeb6d1ee93 (patch) | |
tree | e93f29d3a253b061ce1c7828252a4522f6deca11 /src/api | |
parent | 532889b04d46ada4bfce65904f03c8f4db727368 (diff) | |
download | wix-90b1d345326fd05e701c82fa874590aeb6d1ee93.tar.gz wix-90b1d345326fd05e701c82fa874590aeb6d1ee93.tar.bz2 wix-90b1d345326fd05e701c82fa874590aeb6d1ee93.zip |
Update READMEs to include OSMF
Fixes 7862
Fixes 8974
Diffstat (limited to 'src/api')
8 files changed, 143 insertions, 3 deletions
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md b/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md new file mode 100644 index 00000000..eeedbf9f --- /dev/null +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/README.md | |||
@@ -0,0 +1,37 @@ | |||
1 | # WixToolset.BootstrapperApplicationApi - managed BootstrapperApplication API | ||
2 | |||
3 | The `WixToolset.BootstrapperApplicationApi` package contains the SDK for building managed BootstrapperApplications. | ||
4 | |||
5 | [Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] | ||
6 | |||
7 | |||
8 | ## Open Source Maintenance Fee | ||
9 | |||
10 | 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]. | ||
11 | |||
12 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
13 | |||
14 | |||
15 | ## Getting started | ||
16 | |||
17 | 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. | ||
18 | |||
19 | The best way to learn is via the samples at: https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions | ||
20 | |||
21 | |||
22 | ## Additional resources | ||
23 | |||
24 | * [WiX Website][web] | ||
25 | * [WiX Documentation][docs] | ||
26 | * [WiX Issue Tracker][issues] | ||
27 | * [WiX Discussions][discussions] | ||
28 | |||
29 | |||
30 | [web]: https://www.firegiant.com/wixtoolset/ | ||
31 | [docs]: https://docs.firegiant.com/wixtoolset/ | ||
32 | [issues]: https://github.com/wixtoolset/issues/issues | ||
33 | [discussions]: https://github.com/orgs/wixtoolset/discussions | ||
34 | [sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ | ||
35 | [osmf]: https://opensourcemaintenancefee.org/ | ||
36 | [license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT | ||
37 | [eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt | ||
diff --git a/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec b/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec index 63acc895..73fef99b 100644 --- a/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec +++ b/src/api/burn/WixToolset.BootstrapperApplicationApi/WixToolset.BootstrapperApplicationApi.nuspec | |||
@@ -7,6 +7,7 @@ | |||
7 | <description>$description$</description> | 7 | <description>$description$</description> |
8 | <authors>$authors$</authors> | 8 | <authors>$authors$</authors> |
9 | <icon>icon.png</icon> | 9 | <icon>icon.png</icon> |
10 | <readme>README.md</readme> | ||
10 | <license type="file">OSMFEULA.txt</license> | 11 | <license type="file">OSMFEULA.txt</license> |
11 | <requireLicenseAcceptance>true</requireLicenseAcceptance> | 12 | <requireLicenseAcceptance>true</requireLicenseAcceptance> |
12 | <tags>$packageTags$</tags> | 13 | <tags>$packageTags$</tags> |
@@ -25,6 +26,7 @@ | |||
25 | <files> | 26 | <files> |
26 | <file src="$eulaTxt$" /> | 27 | <file src="$eulaTxt$" /> |
27 | <file src="$iconPng$" /> | 28 | <file src="$iconPng$" /> |
29 | <file src="$projectFolder$\README.md" /> | ||
28 | 30 | ||
29 | <file src="$projectFolder$\build\WixToolset.BootstrapperApplicationApi.props" target="build\" /> | 31 | <file src="$projectFolder$\build\WixToolset.BootstrapperApplicationApi.props" target="build\" /> |
30 | 32 | ||
diff --git a/src/api/burn/bextutil/README.md b/src/api/burn/bextutil/README.md new file mode 100644 index 00000000..cee7e98c --- /dev/null +++ b/src/api/burn/bextutil/README.md | |||
@@ -0,0 +1,30 @@ | |||
1 | # WixToolset.BootstrapperExtensionApi - extend WiX Bootstrapper Engine | ||
2 | |||
3 | The `WixToolset.BootstrapperExtensionApi` package contains the SDK for extending the WiX Bootstrapper Engine, better known as "burn". | ||
4 | |||
5 | [Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] | ||
6 | |||
7 | |||
8 | ## Open Source Maintenance Fee | ||
9 | |||
10 | 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]. | ||
11 | |||
12 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
13 | |||
14 | |||
15 | ## Additional resources | ||
16 | |||
17 | * [WiX Website][web] | ||
18 | * [WiX Documentation][docs] | ||
19 | * [WiX Issue Tracker][issues] | ||
20 | * [WiX Discussions][discussions] | ||
21 | |||
22 | |||
23 | [web]: https://www.firegiant.com/wixtoolset/ | ||
24 | [docs]: https://docs.firegiant.com/wixtoolset/ | ||
25 | [issues]: https://github.com/wixtoolset/issues/issues | ||
26 | [discussions]: https://github.com/orgs/wixtoolset/discussions | ||
27 | [sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ | ||
28 | [osmf]: https://opensourcemaintenancefee.org/ | ||
29 | [license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT | ||
30 | [eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt | ||
diff --git a/src/api/burn/bextutil/bextutil.nuspec b/src/api/burn/bextutil/bextutil.nuspec index f790e0b8..065b72a3 100644 --- a/src/api/burn/bextutil/bextutil.nuspec +++ b/src/api/burn/bextutil/bextutil.nuspec | |||
@@ -7,6 +7,7 @@ | |||
7 | <description>$description$</description> | 7 | <description>$description$</description> |
8 | <authors>$authors$</authors> | 8 | <authors>$authors$</authors> |
9 | <icon>icon.png</icon> | 9 | <icon>icon.png</icon> |
10 | <readme>README.md</readme> | ||
10 | <license type="file">OSMFEULA.txt</license> | 11 | <license type="file">OSMFEULA.txt</license> |
11 | <requireLicenseAcceptance>true</requireLicenseAcceptance> | 12 | <requireLicenseAcceptance>true</requireLicenseAcceptance> |
12 | <tags>$packageTags$</tags> | 13 | <tags>$packageTags$</tags> |
@@ -21,6 +22,7 @@ | |||
21 | <files> | 22 | <files> |
22 | <file src="$eulaTxt$" /> | 23 | <file src="$eulaTxt$" /> |
23 | <file src="$iconPng$" /> | 24 | <file src="$iconPng$" /> |
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$\inc\*" target="build\native\include" /> | 27 | <file src="$projectFolder$\inc\*" target="build\native\include" /> |
26 | <file src="$projectFolder$\..\inc\BootstrapperExtensionTypes.h" target="build\native\include" /> | 28 | <file src="$projectFolder$\..\inc\BootstrapperExtensionTypes.h" target="build\native\include" /> |
diff --git a/src/api/wix/WixToolset.Data/README.md b/src/api/wix/WixToolset.Data/README.md new file mode 100644 index 00000000..192e7993 --- /dev/null +++ b/src/api/wix/WixToolset.Data/README.md | |||
@@ -0,0 +1,30 @@ | |||
1 | # WixToolset.Data - fundamental data types for the WiX Toolset | ||
2 | |||
3 | The `WixToolset.Data` package provides the fundamental data types used throughout the WiX Toolset. | ||
4 | |||
5 | [Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] | ||
6 | |||
7 | |||
8 | ## Open Source Maintenance Fee | ||
9 | |||
10 | 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]. | ||
11 | |||
12 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
13 | |||
14 | |||
15 | ## Additional resources | ||
16 | |||
17 | * [WiX Website][web] | ||
18 | * [WiX Documentation][docs] | ||
19 | * [WiX Issue Tracker][issues] | ||
20 | * [WiX Discussions][discussions] | ||
21 | |||
22 | |||
23 | [web]: https://www.firegiant.com/wixtoolset/ | ||
24 | [docs]: https://docs.firegiant.com/wixtoolset/ | ||
25 | [issues]: https://github.com/wixtoolset/issues/issues | ||
26 | [discussions]: https://github.com/orgs/wixtoolset/discussions | ||
27 | [sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ | ||
28 | [osmf]: https://opensourcemaintenancefee.org/ | ||
29 | [license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT | ||
30 | [eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt | ||
diff --git a/src/api/wix/WixToolset.Data/WixToolset.Data.csproj b/src/api/wix/WixToolset.Data/WixToolset.Data.csproj index e2d71e87..257b9415 100644 --- a/src/api/wix/WixToolset.Data/WixToolset.Data.csproj +++ b/src/api/wix/WixToolset.Data/WixToolset.Data.csproj | |||
@@ -6,8 +6,9 @@ | |||
6 | <TargetFrameworks>netstandard2.0</TargetFrameworks> | 6 | <TargetFrameworks>netstandard2.0</TargetFrameworks> |
7 | <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net472</TargetFrameworks> | 7 | <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net472</TargetFrameworks> |
8 | <LangVersion>7.3</LangVersion> | 8 | <LangVersion>7.3</LangVersion> |
9 | <Description>WiX Toolset Data</Description> | ||
10 | <DebugType>embedded</DebugType> | 9 | <DebugType>embedded</DebugType> |
10 | <Description>WiX Toolset Data</Description> | ||
11 | <PackageReadmeFile>README.md</PackageReadmeFile> | ||
11 | <PublishRepositoryUrl>true</PublishRepositoryUrl> | 12 | <PublishRepositoryUrl>true</PublishRepositoryUrl> |
12 | <CreateDocumentationFile>true</CreateDocumentationFile> | 13 | <CreateDocumentationFile>true</CreateDocumentationFile> |
13 | <!-- TODO: This shouldn't be ignored because this is public-facing --> | 14 | <!-- TODO: This shouldn't be ignored because this is public-facing --> |
@@ -15,6 +16,10 @@ | |||
15 | </PropertyGroup> | 16 | </PropertyGroup> |
16 | 17 | ||
17 | <ItemGroup> | 18 | <ItemGroup> |
19 | <None Include="README.md" Pack="true" PackagePath="\" /> | ||
20 | </ItemGroup> | ||
21 | |||
22 | <ItemGroup> | ||
18 | <PackageReference Include="System.IO.Compression" /> | 23 | <PackageReference Include="System.IO.Compression" /> |
19 | </ItemGroup> | 24 | </ItemGroup> |
20 | </Project> | 25 | </Project> |
diff --git a/src/api/wix/WixToolset.Extensibility/README.md b/src/api/wix/WixToolset.Extensibility/README.md new file mode 100644 index 00000000..62dee501 --- /dev/null +++ b/src/api/wix/WixToolset.Extensibility/README.md | |||
@@ -0,0 +1,30 @@ | |||
1 | # WixToolset.Extensibility - extensibility interfaces for the WiX Toolset | ||
2 | |||
3 | The `WixToolset.Extensibility` package provides the interfaces and base classes WiX Extensions implement to extend the WiX Toolset. | ||
4 | |||
5 | [Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] | ||
6 | |||
7 | |||
8 | ## Open Source Maintenance Fee | ||
9 | |||
10 | 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]. | ||
11 | |||
12 | To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). | ||
13 | |||
14 | |||
15 | ## Additional resources | ||
16 | |||
17 | * [WiX Website][web] | ||
18 | * [WiX Documentation][docs] | ||
19 | * [WiX Issue Tracker][issues] | ||
20 | * [WiX Discussions][discussions] | ||
21 | |||
22 | |||
23 | [web]: https://www.firegiant.com/wixtoolset/ | ||
24 | [docs]: https://docs.firegiant.com/wixtoolset/ | ||
25 | [issues]: https://github.com/wixtoolset/issues/issues | ||
26 | [discussions]: https://github.com/orgs/wixtoolset/discussions | ||
27 | [sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ | ||
28 | [osmf]: https://opensourcemaintenancefee.org/ | ||
29 | [license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT | ||
30 | [eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt | ||
diff --git a/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj b/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj index 86ee754d..f0938b6f 100644 --- a/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj +++ b/src/api/wix/WixToolset.Extensibility/WixToolset.Extensibility.csproj | |||
@@ -5,14 +5,18 @@ | |||
5 | <PropertyGroup> | 5 | <PropertyGroup> |
6 | <TargetFrameworks>netstandard2.0</TargetFrameworks> | 6 | <TargetFrameworks>netstandard2.0</TargetFrameworks> |
7 | <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net472</TargetFrameworks> | 7 | <TargetFrameworks Condition=" '$(Configuration)'=='Release' ">$(TargetFrameworks);net472</TargetFrameworks> |
8 | <Title>WiX Toolset Extensibility</Title> | ||
9 | <Description></Description> | ||
10 | <DebugType>embedded</DebugType> | 8 | <DebugType>embedded</DebugType> |
9 | <Description>WiX Toolset Extensibility</Description> | ||
10 | <PackageReadmeFile>README.md</PackageReadmeFile> | ||
11 | <PublishRepositoryUrl>true</PublishRepositoryUrl> | 11 | <PublishRepositoryUrl>true</PublishRepositoryUrl> |
12 | <CreateDocumentationFile>true</CreateDocumentationFile> | 12 | <CreateDocumentationFile>true</CreateDocumentationFile> |
13 | </PropertyGroup> | 13 | </PropertyGroup> |
14 | 14 | ||
15 | <ItemGroup> | 15 | <ItemGroup> |
16 | <None Include="README.md" Pack="true" PackagePath="\" /> | ||
17 | </ItemGroup> | ||
18 | |||
19 | <ItemGroup> | ||
16 | <ProjectReference Include="..\WixToolset.Data\WixToolset.Data.csproj" /> | 20 | <ProjectReference Include="..\WixToolset.Data\WixToolset.Data.csproj" /> |
17 | </ItemGroup> | 21 | </ItemGroup> |
18 | </Project> | 22 | </Project> |