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/libs/WixToolset.Versioning/README.md | 30 ++++++++++++++++++++ .../WixToolset.Versioning.csproj | 5 ++++ src/libs/dutil/README.md | 32 ++++++++++++++++++++-- src/libs/wcautil/README.md | 32 ++++++++++++++++++++-- 4 files changed, 95 insertions(+), 4 deletions(-) create mode 100644 src/libs/WixToolset.Versioning/README.md (limited to 'src/libs') diff --git a/src/libs/WixToolset.Versioning/README.md b/src/libs/WixToolset.Versioning/README.md new file mode 100644 index 00000000..d24f1c5a --- /dev/null +++ b/src/libs/WixToolset.Versioning/README.md @@ -0,0 +1,30 @@ +# WixToolset.Versioning - WiX Toolset Versioning library + +The `WixToolset.Versioning` package provides methods for handling the various version types supported in the WiX Toolset. Standard 4-part versions (#.#.#.#) are supported as is SemVer (#.#.#-pre.#) and tolerance for very unusual versions created by other installation technologies. + +[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/libs/WixToolset.Versioning/WixToolset.Versioning.csproj b/src/libs/WixToolset.Versioning/WixToolset.Versioning.csproj index 2c23f391..504e8a19 100644 --- a/src/libs/WixToolset.Versioning/WixToolset.Versioning.csproj +++ b/src/libs/WixToolset.Versioning/WixToolset.Versioning.csproj @@ -7,8 +7,13 @@ $(TargetFrameworks);net472 7.3 WiX Toolset Versioning + README.md embedded true true + + + + diff --git a/src/libs/dutil/README.md b/src/libs/dutil/README.md index 2d6605fe..ffc0aacd 100644 --- a/src/libs/dutil/README.md +++ b/src/libs/dutil/README.md @@ -1,2 +1,30 @@ -# dutil -dutil.lib - foundation library for all native code in WiX Toolset +# WixToolset.DUtil (dutil.lib) - foundation library for all native code in WiX Toolset + +The `WixToolset.DUtil` package provides native code utility functions used throughout the WiX Toolset. + +[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/libs/wcautil/README.md b/src/libs/wcautil/README.md index aa004554..15c49400 100644 --- a/src/libs/wcautil/README.md +++ b/src/libs/wcautil/README.md @@ -1,2 +1,30 @@ -# wcautil -wcautil.lib - WiX Toolset Custom Action native utility library +# WixToolset.WcaUtil (wcautil.lib) - WiX Toolset Custom Action native utility library + +The `WixToolset.WcaUtil` package provides native code functions to aid the development of Custom Actions. + +[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 -- cgit v1.2.3-55-g6feb