From 90b1d345326fd05e701c82fa874590aeb6d1ee93 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Fri, 4 Apr 2025 13:33:48 -0700 Subject: Update READMEs to include OSMF Fixes 7862 Fixes 8974 --- src/dtf/WixToolset.Dtf.Compression.Cab/README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.Compression.Cab.csproj | 2 ++ src/dtf/WixToolset.Dtf.Compression.Zip/README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.Compression.Zip.csproj | 5 ++++ src/dtf/WixToolset.Dtf.Compression/README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.Compression.csproj | 2 ++ src/dtf/WixToolset.Dtf.CustomAction/README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.CustomAction.csproj | 1 - .../WixToolset.Dtf.CustomAction.nuspec | 2 ++ src/dtf/WixToolset.Dtf.Resources/README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.Resources.csproj | 5 ++++ .../WixToolset.Dtf.WindowsInstaller.Linq/README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.WindowsInstaller.Linq.csproj | 5 ++++ .../README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.WindowsInstaller.Package.csproj | 5 ++++ src/dtf/WixToolset.Dtf.WindowsInstaller/README.md | 30 ++++++++++++++++++++++ .../WixToolset.Dtf.WindowsInstaller.csproj | 2 ++ 17 files changed, 268 insertions(+), 1 deletion(-) create mode 100644 src/dtf/WixToolset.Dtf.Compression.Cab/README.md create mode 100644 src/dtf/WixToolset.Dtf.Compression.Zip/README.md create mode 100644 src/dtf/WixToolset.Dtf.Compression/README.md create mode 100644 src/dtf/WixToolset.Dtf.CustomAction/README.md create mode 100644 src/dtf/WixToolset.Dtf.Resources/README.md create mode 100644 src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/README.md create mode 100644 src/dtf/WixToolset.Dtf.WindowsInstaller.Package/README.md create mode 100644 src/dtf/WixToolset.Dtf.WindowsInstaller/README.md (limited to 'src/dtf') diff --git a/src/dtf/WixToolset.Dtf.Compression.Cab/README.md b/src/dtf/WixToolset.Dtf.Compression.Cab/README.md new file mode 100644 index 00000000..d67ea7d1 --- /dev/null +++ b/src/dtf/WixToolset.Dtf.Compression.Cab/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.Compression.Cab - managed cabinet compression API + +The `WixToolset.Dtf.Compression.Cab` package contains the managed libraries for cabinet archive packing and unpacking. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.Compression.Cab/WixToolset.Dtf.Compression.Cab.csproj b/src/dtf/WixToolset.Dtf.Compression.Cab/WixToolset.Dtf.Compression.Cab.csproj index 08a88b30..e6ed8004 100644 --- a/src/dtf/WixToolset.Dtf.Compression.Cab/WixToolset.Dtf.Compression.Cab.csproj +++ b/src/dtf/WixToolset.Dtf.Compression.Cab/WixToolset.Dtf.Compression.Cab.csproj @@ -7,11 +7,13 @@ WixToolset.Dtf.Compression.Cab netstandard2.0;net20 Managed libraries for cabinet archive packing and unpacking + README.md true + diff --git a/src/dtf/WixToolset.Dtf.Compression.Zip/README.md b/src/dtf/WixToolset.Dtf.Compression.Zip/README.md new file mode 100644 index 00000000..3837e985 --- /dev/null +++ b/src/dtf/WixToolset.Dtf.Compression.Zip/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.Compression.Zip - managed zip compression API + +The `WixToolset.Dtf.Compression.Zip` package contains the managed libraries for zip archive packing and unpacking. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.Compression.Zip/WixToolset.Dtf.Compression.Zip.csproj b/src/dtf/WixToolset.Dtf.Compression.Zip/WixToolset.Dtf.Compression.Zip.csproj index aa97019d..1d185162 100644 --- a/src/dtf/WixToolset.Dtf.Compression.Zip/WixToolset.Dtf.Compression.Zip.csproj +++ b/src/dtf/WixToolset.Dtf.Compression.Zip/WixToolset.Dtf.Compression.Zip.csproj @@ -7,9 +7,14 @@ WixToolset.Dtf.Compression.Zip netstandard2.0;net20 Managed libraries for zip archive packing and unpacking + README.md true + + + + diff --git a/src/dtf/WixToolset.Dtf.Compression/README.md b/src/dtf/WixToolset.Dtf.Compression/README.md new file mode 100644 index 00000000..b96d3172 --- /dev/null +++ b/src/dtf/WixToolset.Dtf.Compression/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.Compression - managed compression API + +The `WixToolset.Dtf.Compression` package contains the abstract base libraries for archive packing and unpacking. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.Compression/WixToolset.Dtf.Compression.csproj b/src/dtf/WixToolset.Dtf.Compression/WixToolset.Dtf.Compression.csproj index 907e7a04..99a4017c 100644 --- a/src/dtf/WixToolset.Dtf.Compression/WixToolset.Dtf.Compression.csproj +++ b/src/dtf/WixToolset.Dtf.Compression/WixToolset.Dtf.Compression.csproj @@ -7,10 +7,12 @@ WixToolset.Dtf.Compression netstandard2.0;net20 Abstract base libraries for archive packing and unpacking + README.md true + diff --git a/src/dtf/WixToolset.Dtf.CustomAction/README.md b/src/dtf/WixToolset.Dtf.CustomAction/README.md new file mode 100644 index 00000000..ad8621b0 --- /dev/null +++ b/src/dtf/WixToolset.Dtf.CustomAction/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.CustomAction - the WiX Toolset Managed CustomAction Framework + +The `WixToolset.Dtf.CustomAction` package enables developers to create managed custom actions for the Windows Installer. This package contains the tools necessary to convert your project into a managed custom action. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.csproj b/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.csproj index 379aa194..9204e22b 100644 --- a/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.csproj +++ b/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.csproj @@ -7,7 +7,6 @@ false The WiX Toolset Managed CustomAction Framework. The WiX Toolset lets developers create managed custom actions for the Windows Installer. This package contains the tools necessary to convert your project into a managed custom action. - $(OutputPath) diff --git a/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.nuspec b/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.nuspec index 8eb7110f..bac680dc 100644 --- a/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.nuspec +++ b/src/dtf/WixToolset.Dtf.CustomAction/WixToolset.Dtf.CustomAction.nuspec @@ -7,6 +7,7 @@ $description$ $authors$ icon.png + README.md OSMFEULA.txt true $packageTags$ CustomActions @@ -21,6 +22,7 @@ + diff --git a/src/dtf/WixToolset.Dtf.Resources/README.md b/src/dtf/WixToolset.Dtf.Resources/README.md new file mode 100644 index 00000000..00b0ea18 --- /dev/null +++ b/src/dtf/WixToolset.Dtf.Resources/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.Resources - managed executable resource API + +The `WixToolset.Dtf.Resources` package contains support for reading and writing resource data in executable files. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.Resources/WixToolset.Dtf.Resources.csproj b/src/dtf/WixToolset.Dtf.Resources/WixToolset.Dtf.Resources.csproj index 89bff841..41f55dcd 100644 --- a/src/dtf/WixToolset.Dtf.Resources/WixToolset.Dtf.Resources.csproj +++ b/src/dtf/WixToolset.Dtf.Resources/WixToolset.Dtf.Resources.csproj @@ -7,6 +7,11 @@ WixToolset.Dtf.Resources netstandard2.0;net20 Classes for reading and writing resource data in executable files + README.md true + + + + diff --git a/src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/README.md b/src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/README.md new file mode 100644 index 00000000..c667bd4c --- /dev/null +++ b/src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.WindowsInstaller.Linq - managed Widows Installer LINQ extensions + +The `WixToolset.Dtf.WindowsInstaller.Linq` package contains the LINQ extensions for the managed Windows Installer API. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/WixToolset.Dtf.WindowsInstaller.Linq.csproj b/src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/WixToolset.Dtf.WindowsInstaller.Linq.csproj index fbc85880..010fc5af 100644 --- a/src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/WixToolset.Dtf.WindowsInstaller.Linq.csproj +++ b/src/dtf/WixToolset.Dtf.WindowsInstaller.Linq/WixToolset.Dtf.WindowsInstaller.Linq.csproj @@ -7,9 +7,14 @@ WixToolset.Dtf.WindowsInstaller.Linq netstandard2.0;net35 LINQ extensions for Windows Installer classes + README.md true + + + + diff --git a/src/dtf/WixToolset.Dtf.WindowsInstaller.Package/README.md b/src/dtf/WixToolset.Dtf.WindowsInstaller.Package/README.md new file mode 100644 index 00000000..e9eea708 --- /dev/null +++ b/src/dtf/WixToolset.Dtf.WindowsInstaller.Package/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.WindowsInstaller.Package - managed extended Windows Installer API + +The `WixToolset.Dtf.WindowsInstaller.Package` package contains extended managed libraries for accessing the Windows Installer API. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.WindowsInstaller.Package/WixToolset.Dtf.WindowsInstaller.Package.csproj b/src/dtf/WixToolset.Dtf.WindowsInstaller.Package/WixToolset.Dtf.WindowsInstaller.Package.csproj index b3952177..85442fc4 100644 --- a/src/dtf/WixToolset.Dtf.WindowsInstaller.Package/WixToolset.Dtf.WindowsInstaller.Package.csproj +++ b/src/dtf/WixToolset.Dtf.WindowsInstaller.Package/WixToolset.Dtf.WindowsInstaller.Package.csproj @@ -7,9 +7,14 @@ WixToolset.Dtf.WindowsInstaller.Package netstandard2.0;net20 Extended managed libraries for Windows Installer + README.md true + + + + diff --git a/src/dtf/WixToolset.Dtf.WindowsInstaller/README.md b/src/dtf/WixToolset.Dtf.WindowsInstaller/README.md new file mode 100644 index 00000000..22cefde7 --- /dev/null +++ b/src/dtf/WixToolset.Dtf.WindowsInstaller/README.md @@ -0,0 +1,30 @@ +# WixToolset.Dtf.WindowsInstaller - managed Windows Installer API + +The `WixToolset.Dtf.WindowsInstaller` package contains managed libraries for accessing the Windows Installer. + +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] + + +## Open Source Maintenance Fee + +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]. + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + + +[web]: https://www.firegiant.com/wixtoolset/ +[docs]: https://docs.firegiant.com/wixtoolset/ +[issues]: https://github.com/wixtoolset/issues/issues +[discussions]: https://github.com/orgs/wixtoolset/discussions +[sdk]: https://www.nuget.org/packages/WixToolset.Sdk/ +[osmf]: https://opensourcemaintenancefee.org/ +[license]: https://github.com/wixtoolset/wix/blob/main/LICENSE.TXT +[eula]: https://github.com/wixtoolset/wix/blob/main/OSMFEULA.txt diff --git a/src/dtf/WixToolset.Dtf.WindowsInstaller/WixToolset.Dtf.WindowsInstaller.csproj b/src/dtf/WixToolset.Dtf.WindowsInstaller/WixToolset.Dtf.WindowsInstaller.csproj index 117a4114..55a9dc79 100644 --- a/src/dtf/WixToolset.Dtf.WindowsInstaller/WixToolset.Dtf.WindowsInstaller.csproj +++ b/src/dtf/WixToolset.Dtf.WindowsInstaller/WixToolset.Dtf.WindowsInstaller.csproj @@ -7,6 +7,7 @@ WixToolset.Dtf.WindowsInstaller netstandard2.0;net20 Managed libraries for Windows Installer + README.md true @@ -17,6 +18,7 @@ + -- cgit v1.2.3-55-g6feb