Fixing packages, readmes and (c)

nunit · Nov 3, 2023 · c0ce832 · c0ce832
1 parent d26355a
commit c0ce832
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 3 deletions.
diff --git a/build.cake b/build.cake
@@ -235,7 +235,8 @@ var RootFiles = new FilePath[]
 {
     "LICENSE.txt",
     "NOTICES.txt",
-    "CHANGES.md"
+    "CHANGES.md",
+    "README.md"
 };
 
 // Not all of these are present in every framework

diff --git a/nuget/framework/nunit.nuspec b/nuget/framework/nunit.nuspec
@@ -11,6 +11,7 @@
     <repository type="git" url="https://github.com/nunit/nunit"/>
     <iconUrl>https://cdn.rawgit.com/nunit/resources/master/images/icon/nunit_256.png</iconUrl>
     <icon>icon.png</icon>
+    <readme>README.md</readme>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <summary>NUnit is a unit-testing framework for all .NET languages with a strong TDD focus.</summary>
     <description>NUnit features a fluent assert syntax, parameterized, generic and theory tests and is user-extensible.
@@ -23,7 +24,7 @@ Supported platforms:
     <releaseNotes>This package includes the NUnit 3 framework assembly, which is referenced by your tests. You will need to install version 3 of the nunit3-console program or a third-party runner that supports NUnit 3 in order to execute tests. Runners intended for use with NUnit 2.x will not run NUnit 3 tests correctly.</releaseNotes>
     <language>en-US</language>
     <tags>nunit test testing tdd framework fluent assert theory plugin addin</tags>
-    <copyright>Copyright (c) 2022 Charlie Poole, Rob Prouse</copyright>
+    <copyright>Copyright (c) 2023 Charlie Poole, Rob Prouse</copyright>
     <dependencies>
       <group targetFramework="net35" />
       <group targetFramework="net40" />
@@ -37,6 +38,7 @@ Supported platforms:
     <file src="LICENSE.txt" />
     <file src="NOTICES.txt" />
     <file src="CHANGES.md" />
+    <file src="README.md" />
     <file src="..\..\nuget\icon.png" />
     <file src="bin/net35/nunit.framework.dll" target="lib\net35" />
     <file src="bin/net35/nunit.framework.xml" target="lib\net35" />

diff --git a/nuget/nunitlite/nunitlite.nuspec b/nuget/nunitlite/nunitlite.nuspec
@@ -11,6 +11,7 @@
     <repository type="git" url="https://github.com/nunit/nunit"/>
     <iconUrl>https://cdn.rawgit.com/nunit/resources/master/images/icon/nunit_256.png</iconUrl>
     <icon>icon.png</icon>
+    <readme>README.md</readme>
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <summary>NUnitlite is a lightweight runner for tests that use the NUnit testing framework.</summary>
     <description>NUnitLite provides a simple way to run NUnit tests, without the overhead of a full NUnit installation. It is suitable for projects that want to have a quick way to run tests using a console runner and don't need all the features of the NUnit engine and console runner.
@@ -28,7 +29,7 @@ How to use this package:
 3. Add your tests to the test project and simply start the project to execute them.</description>
     <language>en-US</language>
     <tags>test unit testing tdd framework fluent assert device phone embedded</tags>
-    <copyright>Copyright (c) 2022 Charlie Poole, Rob Prouse</copyright>
+    <copyright>Copyright (c) 2023 Charlie Poole, Rob Prouse</copyright>
     <dependencies>
       <group targetFramework="net35">
         <dependency id="NUnit" version="[$version$]" />
@@ -61,6 +62,7 @@ How to use this package:
     <file src="LICENSE.txt" />
     <file src="NOTICES.txt" />
     <file src="CHANGES.md" />
+    <file src="README.md" />
     <file src="..\..\nuget\icon.png" />
     <file src="bin/net35/nunitlite.dll" target="lib\net35" />
     <file src="bin/net35/nunitlite.pdb" target="lib\net35" />

diff --git a/src/NUnitFramework/framework/nunit.framework.csproj b/src/NUnitFramework/framework/nunit.framework.csproj
@@ -4,7 +4,12 @@
     <TargetFrameworks>$(NUnitLibraryFrameworks)</TargetFrameworks>
     <RootNamespace>NUnit.Framework</RootNamespace>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
+
+    <ItemGroup>
+        <None Include="..\..\..\README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.0" />

diff --git a/src/NUnitFramework/nunitlite/nunitlite.csproj b/src/NUnitFramework/nunitlite/nunitlite.csproj
@@ -3,8 +3,13 @@
   <PropertyGroup>
     <TargetFrameworks>$(NUnitLibraryFrameworks)</TargetFrameworks>
     <RootNamespace>NUnitLite</RootNamespace>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
+    <ItemGroup>
+        <None Include="..\..\..\README.md" Pack="true" PackagePath="\"/>
+    </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\framework\nunit.framework.csproj" />
   </ItemGroup>