Add README files and enable XML documentation for all NuGet packages

Plugins/Reqnroll.Autofac.ReqnrollPlugin/README.md

@@ -0,0 +1,28 @@
+Reqnroll.Autofac provides [Autofac](https://github.com/autofac/Autofac) dependency injection integration for Reqnroll.
+
+This package enables Reqnroll to use Autofac as the dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests.
+
+## Key Features
+
+- **Autofac Integration**: Use Autofac as your DI container in Reqnroll projects
+- **Step Definition Injection**: Automatic dependency injection for step definition classes
+- **Hook Injection**: Dependency injection support for before/after hooks
+- **Lifecycle Management**: Proper scoping and lifecycle management of dependencies
+
+## Installation
+
+Install this package to add Autofac dependency injection support to your Reqnroll project:
+
+```powershell
+dotnet add package Reqnroll.Autofac
+```
+
+## Documentation
+
+For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.ReqnrollPlugin.csproj

@@ -10,6 +10,8 @@
     <NuspecFile>$(MSBuildThisFileDirectory)Reqnroll.Autofac.nuspec</NuspecFile>
 
     <RootNamespace>Reqnroll.Autofac</RootNamespace>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

Plugins/Reqnroll.Autofac.ReqnrollPlugin/Reqnroll.Autofac.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll Autofac integration plugin</title>
     <authors>Gaspar Nagy, Spec Solutions, $author$</authors>
     <owners>Gaspar Nagy, Spec Solutions, $owner$</owners>
+    <readme>README.md</readme>
     <description>Reqnroll plugin that enables to use Autofac for resolving test dependencies.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.Autofac.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.CustomPlugin/README.md

@@ -0,0 +1,29 @@
+Reqnroll.CustomPlugin provides a sample custom plugin for Reqnroll.
+
+This package serves as a template and example for creating custom plugins that extend Reqnroll functionality. It demonstrates how to create custom generators, transformations, and other extensions.
+
+## Key Features
+
+- **Plugin Template**: Serves as a starting point for custom plugin development
+- **Extension Examples**: Shows how to extend Reqnroll functionality
+- **Custom Generators**: Demonstrates custom code generation capabilities
+- **Plugin Architecture**: Illustrates Reqnroll's plugin architecture
+- **Development Guide**: Provides examples for plugin developers
+
+## Installation
+
+This package is primarily for development and educational purposes:
+
+```powershell
+dotnet add package Reqnroll.CustomPlugin
+```
+
+## Documentation
+
+For more information about creating custom Reqnroll plugins, visit the [Reqnroll documentation](https://docs.reqnroll.net/).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.csproj

@@ -7,7 +7,8 @@
 
     <CopyLocalLockFileAssemblies>true</CopyLocalLockFileAssemblies>
     <NoPackageAnalysis>true</NoPackageAnalysis>
-
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

Plugins/Reqnroll.CustomPlugin/Reqnroll.CustomPlugin.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.CustomPlugin</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package for writing custom generator extensions for Reqnroll.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="$SolutionDir$\Licenses\*" target="Licenses" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 

Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/README.md

@@ -0,0 +1,29 @@
+Reqnroll.ExternalData provides external data loading capabilities for Reqnroll scenarios.
+
+This package enables Reqnroll to load test data from external sources such as CSV files, JSON files, and other data formats, allowing for more flexible and maintainable test scenarios.
+
+## Key Features
+
+- **External Data Sources**: Load test data from CSV, JSON, and other file formats
+- **Scenario Outlines Enhancement**: Extend scenario outlines with external data
+- **Dynamic Data Loading**: Load data dynamically during test execution
+- **Multiple Formats**: Support for various data file formats
+- **Data Transformation**: Transform and filter external data as needed
+
+## Installation
+
+Install this package to add external data loading support to your Reqnroll project:
+
+```powershell
+dotnet add package Reqnroll.ExternalData
+```
+
+## Documentation
+
+For more information about using external data with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.ExternalData/Reqnroll.ExternalData.ReqnrollPlugin/Reqnroll.ExternalData.nuspec

@@ -5,6 +5,7 @@
     <title>Reqnroll.ExternalData</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use external data in Gherkin scenarios</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -24,6 +25,7 @@
     <file src="bin\$config$\netstandard2.0\*" target="build\netstandard2.0"/>
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,34 @@
+Reqnroll.MSTest enables using Reqnroll with [MSTest v2 test framework](https://learn.microsoft.com/en-us/dotnet/core/testing/unit-testing-csharp-with-mstest).
+
+This package provides integration between Reqnroll and MSTest, allowing you to write BDD tests using Gherkin syntax that run with the MSTest test framework.
+
+## Key Features
+
+- **MSTest Integration**: Seamless integration with MSTest v2 test framework
+- **Gherkin Support**: Write tests using Gherkin Given-When-Then syntax
+- **Test Discovery**: Automatic test discovery by MSTest runners
+- **Parameterized Tests**: Support for scenario outlines and examples
+- **Parallel Execution**: Support for parallel test execution
+
+## Installation
+
+Install this package to add Reqnroll support to your MSTest project:
+
+```powershell
+dotnet add package Reqnroll.MSTest
+```
+
+This package automatically includes:
+- Reqnroll core functionality
+- MSTest integration components
+- Build-time code generation tools
+
+## Documentation
+
+For more information about using Reqnroll with MSTest, visit the [Reqnroll documentation](https://docs.reqnroll.net/).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.Generator.ReqnrollPlugin.csproj

@@ -7,6 +7,8 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
     <PackageId>Reqnroll.MsTest</PackageId>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
   <ItemGroup>
     <Compile Remove="build\**\*" />

Plugins/Reqnroll.MSTest.Generator.ReqnrollPlugin/Reqnroll.MSTest.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.MsTest</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll for use with MsTest v2. $summary$</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -32,6 +33,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.MSTest.Generator.ReqnrollPlugin.pdb" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/README.md

@@ -0,0 +1,29 @@
+Reqnroll.Microsoft.Extensions.DependencyInjection provides [Microsoft.Extensions.DependencyInjection](https://learn.microsoft.com/en-us/dotnet/core/extensions/dependency-injection-usage) integration for Reqnroll.
+
+This package enables Reqnroll to use the standard .NET dependency injection container for resolving step definitions, hooks, and other dependencies in your BDD tests.
+
+## Key Features
+
+- **Microsoft DI Integration**: Use the standard .NET DI container in Reqnroll projects
+- **Step Definition Injection**: Automatic dependency injection for step definition classes
+- **Hook Injection**: Dependency injection support for before/after hooks
+- **Service Collection Support**: Easy registration using IServiceCollection
+- **Scope Management**: Proper scoping and lifecycle management of dependencies
+
+## Installation
+
+Install this package to add Microsoft.Extensions.DependencyInjection support to your Reqnroll project:
+
+```powershell
+dotnet add package Reqnroll.Microsoft.Extensions.DependencyInjection
+```
+
+## Documentation
+
+For more information about using dependency injection with Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin/Reqnroll.Microsoft.Extensions.DependencyInjection.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll Microsoft.Extensions.DependencyInjection integration plugin</title>
     <authors>Mark Hoek, Solid Token, Stef Heyenrath, $author$</authors>
     <owners>Mark Hoek, Solid Token, Stef Heyenrath, $owner$</owners>
+    <readme>README.md</readme>
     <description>Reqnroll plugin that enables to use Microsoft.Extensions.DependencyInjection for resolving test dependencies.</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -29,6 +30,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.Microsoft.Extensions.DependencyInjection.ReqnrollPlugin.pdb" target="lib\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,35 @@
+Reqnroll.NUnit enables using Reqnroll with [NUnit test framework](https://nunit.org/).
+
+This package provides integration between Reqnroll and NUnit, allowing you to write BDD tests using Gherkin syntax that run with the NUnit test framework.
+
+## Key Features
+
+- **NUnit Integration**: Seamless integration with NUnit test framework
+- **Gherkin Support**: Write tests using Gherkin Given-When-Then syntax
+- **Test Discovery**: Automatic test discovery by NUnit runners
+- **Parameterized Tests**: Support for scenario outlines and examples
+- **Parallel Execution**: Support for parallel test execution
+- **Rich Assertions**: Full access to NUnit's assertion framework
+
+## Installation
+
+Install this package to add Reqnroll support to your NUnit project:
+
+```powershell
+dotnet add package Reqnroll.NUnit
+```
+
+This package automatically includes:
+- Reqnroll core functionality
+- NUnit integration components
+- Build-time code generation tools
+
+## Documentation
+
+For more information about using Reqnroll with NUnit, visit the [Reqnroll documentation](https://docs.reqnroll.net/).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.Generator.ReqnrollPlugin.csproj

@@ -7,6 +7,8 @@
     <PublicSign>$(Reqnroll_PublicSign)</PublicSign>
     <PackageId>Reqnroll.NUnit</PackageId>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
   </PropertyGroup>
   <ItemGroup>
     <Compile Remove="build\**\*" />

Plugins/Reqnroll.NUnit.Generator.ReqnrollPlugin/Reqnroll.NUnit.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.NUnit</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Package to use Reqnroll with NUnit 3.13 and later. $summary$</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -32,6 +33,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.NUnit.Generator.ReqnrollPlugin.pdb" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>

Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/README.md

@@ -0,0 +1,29 @@
+Reqnroll.SpecFlowCompatibility provides compatibility layer for migrating from SpecFlow to Reqnroll.
+
+This package helps ease the [migration from SpecFlow](https://docs.reqnroll.net/latest/guides/migrating-from-specflow.html) by providing compatibility shims and adapters, allowing you to gradually migrate your existing SpecFlow tests to Reqnroll.
+
+## Key Features
+
+- **Migration Support**: Ease the transition from SpecFlow to Reqnroll
+- **Compatibility Layer**: Provides compatibility with existing SpecFlow code
+- **Gradual Migration**: Allows incremental migration of test suites
+- **API Compatibility**: Maintains compatibility with common SpecFlow APIs
+- **Legacy Code Support**: Supports legacy SpecFlow patterns and conventions
+
+## Installation
+
+Install this package to add SpecFlow compatibility support to your Reqnroll project:
+
+```powershell
+dotnet add package Reqnroll.SpecFlowCompatibility
+```
+
+## Documentation
+
+For more information about migrating from SpecFlow to Reqnroll, visit the [Reqnroll documentation](https://docs.reqnroll.net/).
+
+## Support
+
+- [Reqnroll Documentation](https://docs.reqnroll.net/)
+- [GitHub Issues](https://github.com/reqnroll/Reqnroll/issues)
+- [Community Discussions](https://github.com/reqnroll/Reqnroll/discussions)

Plugins/Reqnroll.SpecFlowCompatibility.Generator.ReqnrollPlugin/Reqnroll.SpecFlowCompatibility.nuspec

@@ -6,6 +6,7 @@
     <title>Reqnroll.SpecFlowCompatibility</title>
     <authors>$author$</authors>
     <owners>$owner$</owners>
+    <readme>README.md</readme>
     <description>Enables SpecFlow compatibility mode for Reqnroll</description>
     <language>en-US</language>
     <projectUrl>https://www.reqnroll.net</projectUrl>
@@ -35,6 +36,7 @@
     <file src="bin\$config$\netstandard2.0\Reqnroll.SpecFlowCompatibility.*" target="build\netstandard2.0" />
 
     <file src="$SolutionDir$LICENSE" target="LICENSE" />
+    <file src="README.md" target="README.md" />
     <file src="$SolutionDir$reqnroll-icon.png" target="images\" />
   </files>
 </package>