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 --- .github/FUNDING.yml | 1 + README.md | 40 ++++++++---- .../README.md | 37 +++++++++++ .../WixToolset.BootstrapperApplicationApi.nuspec | 2 + src/api/burn/bextutil/README.md | 30 +++++++++ src/api/burn/bextutil/bextutil.nuspec | 2 + src/api/wix/WixToolset.Data/README.md | 30 +++++++++ src/api/wix/WixToolset.Data/WixToolset.Data.csproj | 7 ++- src/api/wix/WixToolset.Extensibility/README.md | 30 +++++++++ .../WixToolset.Extensibility.csproj | 8 ++- 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 + src/ext/Bal/README.md | 60 +++++++++++++++++- src/ext/Bal/wixext/README.md | 7 --- ...xToolset.BootstrapperApplications.wixext.csproj | 2 +- src/ext/Bal/wixstdfn/README.md | 38 +++++++++-- src/ext/Bal/wixstdfn/wixstdfn.nuspec | 2 +- src/ext/ComPlus/README.md | 54 +++++++++++++++- .../wixext/WixToolset.ComPlus.wixext.csproj | 5 ++ src/ext/Dependency/README.md | 54 +++++++++++++++- .../wixext/WixToolset.Dependency.wixext.csproj | 5 ++ src/ext/DirectX/README.md | 54 +++++++++++++++- .../wixext/WixToolset.DirectX.wixext.csproj | 5 ++ src/ext/Firewall/README.md | 54 +++++++++++++++- .../wixext/WixToolset.Firewall.wixext.csproj | 5 ++ src/ext/Http/README.md | 54 +++++++++++++++- src/ext/Http/wixext/WixToolset.Http.wixext.csproj | 5 ++ src/ext/Iis/README.md | 54 +++++++++++++++- src/ext/Iis/wixext/WixToolset.Iis.wixext.csproj | 5 ++ src/ext/Msmq/README.md | 54 +++++++++++++++- src/ext/Msmq/wixext/WixToolset.Msmq.wixext.csproj | 5 ++ src/ext/NetFx/README.md | 54 +++++++++++++++- .../NetFx/wixext/WixToolset.Netfx.wixext.csproj | 5 ++ src/ext/PowerShell/README.md | 54 +++++++++++++++- .../wixext/WixToolset.PowerShell.wixext.csproj | 5 ++ src/ext/Sql/README.md | 54 +++++++++++++++- src/ext/Sql/wixext/WixToolset.Sql.wixext.csproj | 5 ++ src/ext/UI/README.md | 54 +++++++++++++++- src/ext/UI/wixext/WixToolset.UI.wixext.csproj | 5 ++ src/ext/Util/README.md | 53 +++++++++++++++- src/ext/Util/wixext/WixToolset.Util.wixext.csproj | 5 ++ src/ext/VisualStudio/README.md | 54 +++++++++++++++- .../wixext/WixToolset.VisualStudio.wixext.csproj | 5 ++ src/libs/WixToolset.Versioning/README.md | 30 +++++++++ .../WixToolset.Versioning.csproj | 5 ++ src/libs/dutil/README.md | 32 +++++++++- src/libs/wcautil/README.md | 32 +++++++++- src/tools/WixToolset.Heat/README.md | 30 +++++++++ src/tools/WixToolset.Heat/WixToolset.Heat.nuspec | 2 + src/wix/WixToolset.Sdk/README.md | 57 +++++++++++++++-- src/wix/pack-wix/README.md | 73 ++++++++++++++++++++-- 66 files changed, 1521 insertions(+), 71 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 src/api/burn/WixToolset.BootstrapperApplicationApi/README.md create mode 100644 src/api/burn/bextutil/README.md create mode 100644 src/api/wix/WixToolset.Data/README.md create mode 100644 src/api/wix/WixToolset.Extensibility/README.md 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 delete mode 100644 src/ext/Bal/wixext/README.md create mode 100644 src/libs/WixToolset.Versioning/README.md create mode 100644 src/tools/WixToolset.Heat/README.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..da958e11 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: wixtoolset diff --git a/README.md b/README.md index 127330ca..d7c49dd9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -WiX Toolset +![The WiX Toolset Logo](https://github.com/wixtoolset/.github/raw/master/profile/images/readme-header.png) [![latest version](https://img.shields.io/nuget/vpre/wix)](https://www.nuget.org/packages/wix) [![download count](https://img.shields.io/nuget/dt/wix)](https://www.nuget.org/stats/packages/WiX?groupby=Version) @@ -6,14 +6,25 @@ # WiX Toolset -This repository contains the WiX Toolset codebase. +The WiX Toolset is the most powerful set of tools available to create your Windows installation experience. This repository contains the WiX Toolset code itself. -# Developing WiX +If you're new to WiX, check out our [Quick Start](https://docs.firegiant.com/quick-start/) to build your first installation package in just a few minutes. -## Prerequisites -- A command line Git client that is in the system path -- Visual Studio 2022 (17.8.2 or higher) with the following installed: +## Open Source Maintenance Fee + +To ensure the long-term sustainability of this project, use of the WiX Toolset requires an [Open Source Maintenance Fee](https://opensourcemaintenancefee.org). While the source code is freely available under the terms of the [LICENSE](./LICENSE.TXT), all other aspects of the project--including opening or commenting on issues, participating in discussions and downloading releases--require [adherence to the Maintenance Fee](./OSMFEULA.txt). + +In short, if you use this project to generate revenue, the [Maintenance Fee is required](./OSMFEULA.txt). + +To pay the Maintenance Fee, [become a Sponsor](https://github.com/sponsors/wixtoolset). + + +## Developing WiX + +### Prerequisites + +Before building the WiX Toolset, ensure you have Visual Studio 2022 (17.8.2 or higher) with the following installed: | Workloads | | :-------- | @@ -32,26 +43,26 @@ This repository contains the WiX Toolset codebase. | MSVC v143 - VS 2022 C++ x64/x86 build tools (Latest) | | Git for Windows | -- [Download the latest nuget.exe command-line tool](https://www.nuget.org/downloads) and put it in a directory on the path. +Also, download the latest [nuget.exe command-line tool](https://www.nuget.org/downloads) and place it in a directory on your path. -##### Getting started: +#### Getting started: * [Fork the WiX repository](https://github.com/wixtoolset/wix/fork) into your own GitHub repository * Clone the WiX repository from your fork (`git clone https://github.com/yourdomain/wix.git`) into the directory of your choice -##### To build the WiX toolset: +#### To build the WiX toolset: * Start a VS2022 'Developer Command Prompt' * Change directory to the root of the cloned repository * Issue the command `devbuild` (or `devbuild release` if you want to create a release version) - ##### Executing your newly built WiX toolset +#### Executing your newly built WiX toolset * `build\wix\Debug\publish\wix\wix --help` (Change `Debug` to `Release` if you built in release mode) - ##### Pull request expectations +#### Pull request expectations * Pick an [outstanding WiX issue](https://github.com/wixtoolset/issues/issues?q=is%3Aissue+is%3Aopen+label%3A%22up+for+grabs%22) (or [create a new one](https://github.com/wixtoolset/issues/issues/new/choose)). Add a comment requesting that you be assigned to the issue. Wait for confirmation. * To create a pull request, [fork a new branch](https://github.com/wixtoolset/wix/fork) from the `main` branch @@ -60,3 +71,10 @@ This repository contains the WiX Toolset codebase. * If the `main` branch has changed since you created your branch, rebase to the latest updates. * If needed (ie, you squashed or rebased), do a force push of your branch * Create a pull request with your branch against the WiX repository. + +## Additional information + +* Web site: https://www.firegiant.com/wixtoolset/ +* Documentation [WiX Documentation](https://docs.firegiant.com/wixtoolset/) +* Issue Tracker: [GitHub Issues](https://github.com/wixtoolset/issues/issues) +* Discussions: [WiX Toolset Discussions](https://github.com/orgs/wixtoolset/discussions) 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 @@ +# WixToolset.BootstrapperApplicationApi - managed BootstrapperApplication API + +The `WixToolset.BootstrapperApplicationApi` package contains the SDK for building managed BootstrapperApplications. + +[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). + + +## Getting started + +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. + +The best way to learn is via the samples at: https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions + + +## 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/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 @@ $description$ $authors$ icon.png + README.md OSMFEULA.txt true $packageTags$ @@ -25,6 +26,7 @@ + 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 @@ +# WixToolset.BootstrapperExtensionApi - extend WiX Bootstrapper Engine + +The `WixToolset.BootstrapperExtensionApi` package contains the SDK for extending the WiX Bootstrapper Engine, better known as "burn". + +[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/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 @@ $description$ $authors$ icon.png + README.md OSMFEULA.txt true $packageTags$ @@ -21,6 +22,7 @@ + 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 @@ +# WixToolset.Data - fundamental data types for the WiX Toolset + +The `WixToolset.Data` package provides the fundamental data types 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/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,14 +6,19 @@ netstandard2.0 $(TargetFrameworks);net472 7.3 - WiX Toolset Data embedded + WiX Toolset Data + README.md true true $(NoWarn);CS1591 + + + + 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 @@ +# WixToolset.Extensibility - extensibility interfaces for the WiX Toolset + +The `WixToolset.Extensibility` package provides the interfaces and base classes WiX Extensions implement to extend 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/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,13 +5,17 @@ netstandard2.0 $(TargetFrameworks);net472 - WiX Toolset Extensibility - embedded + WiX Toolset Extensibility + README.md true true + + + + 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 @@ + diff --git a/src/ext/Bal/README.md b/src/ext/Bal/README.md index 4a14b1a2..5e969c4f 100644 --- a/src/ext/Bal/README.md +++ b/src/ext/Bal/README.md @@ -1,2 +1,58 @@ -# WixToolset.BootstrapperApplications.wixext -WixToolset.BootstrapperApplications.wixext - Bootstrapper Applications WiX Toolset Extension +# WixToolset.BootstrapperApplications.wixext - Bootstrapper Applications WiX Toolset Extension + +This WiX Extension provides the standard BootstrapperApplications provided by the WiX Toolset. + +- WixStdBA ([WixStandardBootstrapperApplication](https://docs.firegiant.com/wix/schema/bal/wixstandardbootstrapperapplication/)), a bootstrapper application with support for custom themes +- WixIuiBA ([WixInternalUIBootstrapperApplication](https://docs.firegiant.com/wix/schema/bal/wixinternaluibootstrapperapplication/)), a bootstrapper application for showing internal UI of Windows Installer packages +- WixPreqBA ([WixPrerequisiteBootstrapperApplication](https://docs.firegiant.com/wix/schema/bal/wixprerequisitebootstrapperapplication/)), a secondary bootstrapper application for bootstrapping the prerequisites needed for a primary bootstrapper application + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the namespace and bootstrapper application of choice: + +``` + + + + + + + +``` + +## 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/ext/Bal/wixext/README.md b/src/ext/Bal/wixext/README.md deleted file mode 100644 index a986cb0e..00000000 --- a/src/ext/Bal/wixext/README.md +++ /dev/null @@ -1,7 +0,0 @@ -# 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 diff --git a/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj b/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj index de32ff4d..adc6a86f 100644 --- a/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj +++ b/src/ext/Bal/wixext/WixToolset.BootstrapperApplications.wixext.csproj @@ -18,7 +18,7 @@ - + diff --git a/src/ext/Bal/wixstdfn/README.md b/src/ext/Bal/wixstdfn/README.md index 0977ff42..4aef768e 100644 --- a/src/ext/Bal/wixstdfn/README.md +++ b/src/ext/Bal/wixstdfn/README.md @@ -1,11 +1,37 @@ -# WixToolset.WixStandardBootstrapperApplicationFunctionApi +# WixToolset.WixStandardBootstrapperApplicationFunctionApi - extend WiX Standard Bootstrapper Application -WixToolset.WixStandardBootstrapperApplicationFunctionApi contains the SDK for building **BAFunctions** extensions for WixStdBA, the WiX Standard Bootstrapper Application for Burn bootstrapper bundles. +The `WixToolset.WixStandardBootstrapperApplicationFunctionApi` package contains the SDK for building **BAFunctions** extensions for WixStdBA, the WiX Standard Bootstrapper Application for Burn bootstrapper bundles. + +[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). + + +## Getting started 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 +The best way to learn is via the samples at: https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + -## Samples -https://github.com/wixtoolset/wix/tree/HEAD/src/ext/Bal/Samples/bafunctions +[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/ext/Bal/wixstdfn/wixstdfn.nuspec b/src/ext/Bal/wixstdfn/wixstdfn.nuspec index 86860b67..d4b6e104 100644 --- a/src/ext/Bal/wixstdfn/wixstdfn.nuspec +++ b/src/ext/Bal/wixstdfn/wixstdfn.nuspec @@ -7,13 +7,13 @@ $description$ $authors$ icon.png + README.md OSMFEULA.txt true $packageTags$ $copyright$ $projectUrl$ - README.md diff --git a/src/ext/ComPlus/README.md b/src/ext/ComPlus/README.md index 8604c104..2412a6d1 100644 --- a/src/ext/ComPlus/README.md +++ b/src/ext/ComPlus/README.md @@ -1,2 +1,52 @@ -# ComPlus.wixext -WixToolset.ComPlus.wixext - COM+ WiX Toolset Extension +# WixToolset.ComPlus.wixext - COM+ WiX Toolset Extension + +This WiX Extension provides support for configuring COM+. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/ComPlus/wixext/WixToolset.ComPlus.wixext.csproj b/src/ext/ComPlus/wixext/WixToolset.ComPlus.wixext.csproj index 1975d7d4..11911b35 100644 --- a/src/ext/ComPlus/wixext/WixToolset.ComPlus.wixext.csproj +++ b/src/ext/ComPlus/wixext/WixToolset.ComPlus.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.ComPlus WiX Toolset ComPlus Extension WiX Toolset ComPlus Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/Dependency/README.md b/src/ext/Dependency/README.md index 09feba68..0d7fd7b3 100644 --- a/src/ext/Dependency/README.md +++ b/src/ext/Dependency/README.md @@ -1,2 +1,52 @@ -# Dependency.wixext -WixToolset.Dependency.wixext - Dependency WiX Toolset Extension +# WixToolset.Dependency.wixext - Dependency WiX Toolset Extension + +This WiX Extension provides support for configuring package dependencies. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/Dependency/wixext/WixToolset.Dependency.wixext.csproj b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.csproj index b61c6665..51010891 100644 --- a/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.csproj +++ b/src/ext/Dependency/wixext/WixToolset.Dependency.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Dependency WiX Toolset Dependency Extension WiX Toolset Dependency Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/DirectX/README.md b/src/ext/DirectX/README.md index 6131cf35..2f9f3f08 100644 --- a/src/ext/DirectX/README.md +++ b/src/ext/DirectX/README.md @@ -1,2 +1,52 @@ -# DirectX.wixext -WixToolset.DirectX.wixext - DirectX WiX Toolset Extension +# WixToolset.DirectX.wixext - DirectX WiX Toolset Extension + +This WiX Extension provides support for configuring DirectX. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/DirectX/wixext/WixToolset.DirectX.wixext.csproj b/src/ext/DirectX/wixext/WixToolset.DirectX.wixext.csproj index 80263e9a..eadbc193 100644 --- a/src/ext/DirectX/wixext/WixToolset.DirectX.wixext.csproj +++ b/src/ext/DirectX/wixext/WixToolset.DirectX.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.DirectX WiX Toolset DirectX Extension WiX Toolset DirectX Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/Firewall/README.md b/src/ext/Firewall/README.md index be5801da..bd2b3fce 100644 --- a/src/ext/Firewall/README.md +++ b/src/ext/Firewall/README.md @@ -1,2 +1,52 @@ -# Firewall.wixext -WixToolset.Firewall.wixext - Firewall WiX Toolset Extension +# WixToolset.Firewall.wixext - Firewall WiX Toolset Extension + +This WiX Extension provides support for configuring Windows Firewall. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/Firewall/wixext/WixToolset.Firewall.wixext.csproj b/src/ext/Firewall/wixext/WixToolset.Firewall.wixext.csproj index 25322dc4..f9032032 100644 --- a/src/ext/Firewall/wixext/WixToolset.Firewall.wixext.csproj +++ b/src/ext/Firewall/wixext/WixToolset.Firewall.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Firewall WiX Toolset Firewall Extension WiX Toolset Firewall Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/Http/README.md b/src/ext/Http/README.md index 2d9f1895..64cbbf51 100644 --- a/src/ext/Http/README.md +++ b/src/ext/Http/README.md @@ -1,2 +1,52 @@ -# Http.wixext -WixToolset.Http.wixext - Http WiX Toolset Extension +# WixToolset.Http.wixext - Http WiX Toolset Extension + +This WiX Extension provides support for configuring HTTP.SYS. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/Http/wixext/WixToolset.Http.wixext.csproj b/src/ext/Http/wixext/WixToolset.Http.wixext.csproj index cee26f86..64c0785c 100644 --- a/src/ext/Http/wixext/WixToolset.Http.wixext.csproj +++ b/src/ext/Http/wixext/WixToolset.Http.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Http WiX Toolset Http Extension WiX Toolset Http Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/Iis/README.md b/src/ext/Iis/README.md index ddb21a82..3344d10c 100644 --- a/src/ext/Iis/README.md +++ b/src/ext/Iis/README.md @@ -1,2 +1,52 @@ -# Iis.wixext -WixToolset.Iis.wixext - Iis WiX Toolset Extension +# WixToolset.Iis.wixext - IIS WiX Toolset Extension + +This WiX Extension provides support for configuring IIS. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/Iis/wixext/WixToolset.Iis.wixext.csproj b/src/ext/Iis/wixext/WixToolset.Iis.wixext.csproj index 79c8dae7..72d32cfa 100644 --- a/src/ext/Iis/wixext/WixToolset.Iis.wixext.csproj +++ b/src/ext/Iis/wixext/WixToolset.Iis.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Iis WiX Toolset Iis Extension WiX Toolset Iis Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/Msmq/README.md b/src/ext/Msmq/README.md index fa3c277f..6ebd70e9 100644 --- a/src/ext/Msmq/README.md +++ b/src/ext/Msmq/README.md @@ -1,2 +1,52 @@ -# Msmq.wixext -WixToolset.Msmq.wixext - MSMQ WiX Toolset Extension +# WixToolset.Msmq.wixext - MSMQ WiX Toolset Extension + +This WiX Extension provides support for configuring MSMQ. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/Msmq/wixext/WixToolset.Msmq.wixext.csproj b/src/ext/Msmq/wixext/WixToolset.Msmq.wixext.csproj index ef369c2c..5aa81b74 100644 --- a/src/ext/Msmq/wixext/WixToolset.Msmq.wixext.csproj +++ b/src/ext/Msmq/wixext/WixToolset.Msmq.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Msmq WiX Toolset MSMQ Extension WiX Toolset MSMQ Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/NetFx/README.md b/src/ext/NetFx/README.md index a31cfd1d..ace02de3 100644 --- a/src/ext/NetFx/README.md +++ b/src/ext/NetFx/README.md @@ -1,2 +1,52 @@ -# NetFx.wixext -WixToolset.NetFx.wixext - .NET Framework WiX Toolset Extension +# WixToolset.NetFx.wixext - .NET Framework WiX Toolset Extension + +This WiX Extension provides support for configuring .NET Framework. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/NetFx/wixext/WixToolset.Netfx.wixext.csproj b/src/ext/NetFx/wixext/WixToolset.Netfx.wixext.csproj index 67759ab3..2c63a42d 100644 --- a/src/ext/NetFx/wixext/WixToolset.Netfx.wixext.csproj +++ b/src/ext/NetFx/wixext/WixToolset.Netfx.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Netfx WiX Toolset .NET extension WiX Toolset .NET extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/PowerShell/README.md b/src/ext/PowerShell/README.md index 6de236f7..7ee2f5e2 100644 --- a/src/ext/PowerShell/README.md +++ b/src/ext/PowerShell/README.md @@ -1,2 +1,52 @@ -# PowerShell.wixext -WixToolset.PowerShell.wixext - PowerShell WiX Toolset Extension +# WixToolset.PowerShell.wixext - PowerShell WiX Toolset Extension + +This WiX Extension provides support for configuring PowerShell. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/PowerShell/wixext/WixToolset.PowerShell.wixext.csproj b/src/ext/PowerShell/wixext/WixToolset.PowerShell.wixext.csproj index 812915a8..93ac837c 100644 --- a/src/ext/PowerShell/wixext/WixToolset.PowerShell.wixext.csproj +++ b/src/ext/PowerShell/wixext/WixToolset.PowerShell.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.PowerShell WiX Toolset PowerShell Extension WiX Toolset PowerShell Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/Sql/README.md b/src/ext/Sql/README.md index 377c9032..adc543c8 100644 --- a/src/ext/Sql/README.md +++ b/src/ext/Sql/README.md @@ -1,2 +1,52 @@ -# Sql.wixext -WixToolset.Sql.wixext - Sql WiX Toolset Extension +# WixToolset.Sql.wixext - Sql WiX Toolset Extension + +This WiX Extension provides support for configuring SQL Server. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/Sql/wixext/WixToolset.Sql.wixext.csproj b/src/ext/Sql/wixext/WixToolset.Sql.wixext.csproj index 28a66297..32386b79 100644 --- a/src/ext/Sql/wixext/WixToolset.Sql.wixext.csproj +++ b/src/ext/Sql/wixext/WixToolset.Sql.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Sql WiX Toolset Sql Extension WiX Toolset Sql Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/UI/README.md b/src/ext/UI/README.md index ebfefedd..19d5ba0c 100644 --- a/src/ext/UI/README.md +++ b/src/ext/UI/README.md @@ -1,2 +1,52 @@ -# UI.wixext -WixToolset.UI.wixext - UI WiX Toolset Extension +# WixToolset.UI.wixext - UI WiX Toolset Extension + +This WiX Extension provides support for standard internal MSI UI. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/UI/wixext/WixToolset.UI.wixext.csproj b/src/ext/UI/wixext/WixToolset.UI.wixext.csproj index 288b4a85..1ba64a5a 100644 --- a/src/ext/UI/wixext/WixToolset.UI.wixext.csproj +++ b/src/ext/UI/wixext/WixToolset.UI.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.UI WiX Toolset UI Extension WiX Toolset UI Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/Util/README.md b/src/ext/Util/README.md index 540c539c..11d7a363 100644 --- a/src/ext/Util/README.md +++ b/src/ext/Util/README.md @@ -1,3 +1,52 @@ -# Util.wixext -WixToolset.Util.wixext - Utility WiX Toolset Extension +# WixToolset.Util.wixext - Utility WiX Toolset Extension +This WiX Extension provides support for configuring various parts of Windows. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/Util/wixext/WixToolset.Util.wixext.csproj b/src/ext/Util/wixext/WixToolset.Util.wixext.csproj index a4fcaf14..2a2a2f6a 100644 --- a/src/ext/Util/wixext/WixToolset.Util.wixext.csproj +++ b/src/ext/Util/wixext/WixToolset.Util.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.Util WiX Toolset Utility extension WiX Toolset Utility extension + README.md embedded @@ -16,6 +17,10 @@ + + + + diff --git a/src/ext/VisualStudio/README.md b/src/ext/VisualStudio/README.md index 76fbd4ce..a418d49b 100644 --- a/src/ext/VisualStudio/README.md +++ b/src/ext/VisualStudio/README.md @@ -1,2 +1,52 @@ -# VisualStudio.wixext -WixToolset.VisualStudio.wixext - Visual Studio WiX Toolset Extension +# WixToolset.VisualStudio.wixext - Visual Studio WiX Toolset Extension + +This WiX Extension provides support for configuring Visual Studio. + +[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). + + +## Getting started + +Add the WiX Extension as a PackageReference to your .wixproj: + +``` + + + + + +``` + +Then add the extension's namespace: + +``` + + + .. + +``` + +## 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/ext/VisualStudio/wixext/WixToolset.VisualStudio.wixext.csproj b/src/ext/VisualStudio/wixext/WixToolset.VisualStudio.wixext.csproj index 0224c98c..eb410c35 100644 --- a/src/ext/VisualStudio/wixext/WixToolset.VisualStudio.wixext.csproj +++ b/src/ext/VisualStudio/wixext/WixToolset.VisualStudio.wixext.csproj @@ -7,6 +7,7 @@ WixToolset.VisualStudio WiX Toolset Visual Studio Extension WiX Toolset VS Extension + README.md embedded @@ -16,6 +17,10 @@ + + + + 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 diff --git a/src/tools/WixToolset.Heat/README.md b/src/tools/WixToolset.Heat/README.md new file mode 100644 index 00000000..7858da67 --- /dev/null +++ b/src/tools/WixToolset.Heat/README.md @@ -0,0 +1,30 @@ +# WixToolset.Heat - old harvesting tool from WiX v3 + +The `WixToolset.Heat` package provides the (now deprecated) harvesting tools originally designed for WiX v3. The bulk of the functionality provided by this package has been eclipsed by the `Files` element. It is recommended to migrate to that new functionality or a custom solution. + +[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/tools/WixToolset.Heat/WixToolset.Heat.nuspec b/src/tools/WixToolset.Heat/WixToolset.Heat.nuspec index 48e94797..f01faa04 100644 --- a/src/tools/WixToolset.Heat/WixToolset.Heat.nuspec +++ b/src/tools/WixToolset.Heat/WixToolset.Heat.nuspec @@ -7,6 +7,7 @@ $description$ $authors$ icon.png + README.md OSMFEULA.txt true $packageTags$ @@ -18,6 +19,7 @@ + diff --git a/src/wix/WixToolset.Sdk/README.md b/src/wix/WixToolset.Sdk/README.md index 6b139d9c..bf93e84b 100644 --- a/src/wix/WixToolset.Sdk/README.md +++ b/src/wix/WixToolset.Sdk/README.md @@ -1,12 +1,59 @@ # 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: +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. -```xml - +[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). + + +## Getting started + +Here's a minimal .wixproj that builds an MSI from the .wxs source files in the project directory: + +Example project file: `QuickStart.wixproj` +``` + ``` -For more information about WiX as an MSBuild SDK, see https://wixtoolset.org/docs/intro/#msbuild. +Example source code: `QuickStart.wxs` +``` + + + + + +``` + +Build your MSI from the command-line: +``` +dotnet build +``` + +For more information about WiX as an MSBuild SDK, see https://docs.firegiant.com/wix/using-wix/#msbuild-and-dotnet-build. + +For more information about WiX targets, properties, and items, see https://docs.firegiant.com/wix/tools/msbuild/. + + +## Additional resources + +* [WiX Website][web] +* [WiX Documentation][docs] +* [WiX Issue Tracker][issues] +* [WiX Discussions][discussions] + -For more information about WiX targets, properties, and items, see https://wixtoolset.org/docs/tools/msbuild/. +[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/wix/pack-wix/README.md b/src/wix/pack-wix/README.md index 95ac7c82..8b03dd48 100644 --- a/src/wix/pack-wix/README.md +++ b/src/wix/pack-wix/README.md @@ -1,7 +1,72 @@ -# wix +# wix - the WiX Toolset from the command-line -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. +The `wix` package provides the WiX Toolset as a .NET Tool, perfect for your command-line packaging pleasure (even if we recommend using the [WixToolset.Sdk][sdk]). -To install WiX as a .NET tool or upgrade to a later version, see https://wixtoolset.org/docs/intro/#nettool. +[Web Site][web] | [Documentation][docs] | [Issue Tracker][issues] | [Discussions][discussions] -To read about available commands and switches, see https://wixtoolset.org/docs/tools/wixexe/. + +## 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). + + +## Before we begin + +For most users, we recommend using the [WixToolset.Sdk][sdk] to build your installation packages instead of this command-line tool. The Sdk provides a better development experience than the command-line, especially as your project grows. The following is a quick example. + +Example project file: `QuickStart.wixproj` +``` + + +``` + +Example source code: `QuickStart.wxs` +``` + + + + + +``` + +Build your MSI from the command-line: +``` +dotnet build +``` + + +## Getting started + +If you still decide to use this command-line tool instead of the [WixToolset.Sdk][sdk], install the latest version with: + +``` +dotnet tool install --global wix +``` + +Verify it was successfully installed with: + +``` +wix --version +``` + +For more information, see https://docs.firegiant.com/wix/using-wix/#command-line-net-tool. To read about available commands and switches, see https://docs.firegiant.com/wix/tools/wixexe/. + + +## 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