Merge pull request #267 from CaptnCodr/build-instructions

Add build instructions etc.
fsprojects · Mar 6, 2024 · 7c72cbc · 7c72cbc
2 parents a1dcb80 + 2e0a138
commit 7c72cbc
Show file tree

Hide file tree

Showing 11 changed files with 20 additions and 25 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -15,7 +15,7 @@
       ]
     },
     "fsdocs-tool": {
-      "version": "19.1.1",
+      "version": "20.0.0",
       "commands": [
         "fsdocs"
       ]

diff --git a/README.md b/README.md
@@ -27,9 +27,7 @@ A few things to keep in mind:
 * Since the unit tests for FsUnit are written with FsUnit, failing tests are just as important as passing tests.
 
 ## Build Instructions
-
-[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/fsprojects/FsUnit)
-
+- Find and run either `./build.sh` or `build.cmd` (depending on your platform).
 
 ## Maintainer(s)
 

diff --git a/build.fsx b/build.fsx
@@ -222,7 +222,7 @@ Target.create "ReleaseDocs" (fun _ ->
     Repository.fullclean tempDocsDir
     Shell.copyRecursive "output" tempDocsDir true |> Trace.tracefn "%A"
     Staging.stageAll tempDocsDir
-    Commit.exec tempDocsDir (sprintf "Update generated documentation for version %s" release.NugetVersion)
+    Commit.exec tempDocsDir (sprintf "Update generated documentation for version %s" version)
     Branches.push tempDocsDir)
 
 // --------------------------------------------------------------------------------------

diff --git a/paket.lock b/paket.lock
@@ -2,25 +2,23 @@ RESTRICTION: || (== net6.0) (== netstandard2.0)
 NUGET
   remote: https://api.nuget.org/v3/index.json
     FSharp.Core (5.0.2)
-    Microsoft.CodeCoverage (17.8) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= net462)) (&& (== netstandard2.0) (>= netcoreapp3.1))
-    Microsoft.NET.Test.Sdk (17.8)
-      Microsoft.CodeCoverage (>= 17.8) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= net462)) (&& (== netstandard2.0) (>= netcoreapp3.1))
-      Microsoft.TestPlatform.TestHost (>= 17.8) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
+    Microsoft.CodeCoverage (17.9) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= net462)) (&& (== netstandard2.0) (>= netcoreapp3.1))
+    Microsoft.NET.Test.Sdk (17.9)
+      Microsoft.CodeCoverage (>= 17.9) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= net462)) (&& (== netstandard2.0) (>= netcoreapp3.1))
+      Microsoft.TestPlatform.TestHost (>= 17.9) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
     Microsoft.NETCore.Platforms (7.0.4)
     Microsoft.NETCore.Targets (5.0)
-    Microsoft.TestPlatform.ObjectModel (17.8) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
-      NuGet.Frameworks (>= 6.5)
+    Microsoft.TestPlatform.ObjectModel (17.9) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
       System.Reflection.Metadata (>= 1.6)
-    Microsoft.TestPlatform.TestHost (17.8) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
-      Microsoft.TestPlatform.ObjectModel (>= 17.8) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
+    Microsoft.TestPlatform.TestHost (17.9) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
+      Microsoft.TestPlatform.ObjectModel (>= 17.9) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
       Newtonsoft.Json (>= 13.0.1) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
     MSTest.TestAdapter (3.0.4)
     MSTest.TestFramework (3.0.4)
     NETStandard.Library (2.0.3)
       Microsoft.NETCore.Platforms (>= 1.1)
     Newtonsoft.Json (13.0.3) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
     NHamcrest (3.4)
-    NuGet.Frameworks (6.8) - restriction: || (== net6.0) (&& (== netstandard2.0) (>= netcoreapp3.1))
     NUnit (4.0.1)
     NUnit3TestAdapter (4.5)
     System.Buffers (4.5.1) - restriction: || (&& (== net6.0) (>= net462)) (== netstandard2.0)
@@ -95,9 +93,8 @@ NUGET
       xunit.assert (>= 2.5.3)
       xunit.core (2.5.3)
     xunit.abstractions (2.0.3)
-    xunit.analyzers (1.7)
-    xunit.assert (2.6.3)
-      NETStandard.Library (>= 1.6.1) - restriction: == netstandard2.0
+    xunit.analyzers (1.11)
+    xunit.assert (2.7)
     xunit.core (2.5.3)
       xunit.extensibility.core (2.5.3)
       xunit.extensibility.execution (2.5.3)
@@ -107,4 +104,4 @@ NUGET
     xunit.extensibility.execution (2.5.3)
       NETStandard.Library (>= 1.6.1)
       xunit.extensibility.core (2.5.3)
-    xunit.runner.visualstudio (2.5.5)
+    xunit.runner.visualstudio (2.5.7)
diff --git a/src/FsUnit.MsTestUnit/paket.template b/src/FsUnit.MsTestUnit/paket.template
@@ -10,7 +10,7 @@ projectUrl
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
 licenseExpression
-    MIT
+    https://licenses.nuget.org/MIT
 licenseUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
 requireLicenseAcceptance

diff --git a/src/FsUnit.MsTestUnit/sample.paket.template b/src/FsUnit.MsTestUnit/sample.paket.template
@@ -10,7 +10,7 @@ projectUrl
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
 licenseExpression
-    MIT
+    https://licenses.nuget.org/MIT
 licenseUrl
     https://github.com/fsprojects/FsUnit/blob/master/license.txt
 requireLicenseAcceptance

diff --git a/src/FsUnit.NUnit/FsUnit.NUnit.fsproj b/src/FsUnit.NUnit/FsUnit.NUnit.fsproj
@@ -6,7 +6,7 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <PropertyGroup Condition="($(DesignTimeBuild) == true)">
-    <DisableImplicitFrameworkReferences>true</DisableImplicitFrameworkReferences>
+    <DisableImplicitFrameworkReferences>false</DisableImplicitFrameworkReferences>
   </PropertyGroup>
   <ItemGroup>
     <Compile Include="AssemblyInfo.fs" />

diff --git a/src/FsUnit.NUnit/paket.template b/src/FsUnit.NUnit/paket.template
@@ -10,7 +10,7 @@ projectUrl
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
 licenseExpression
-    MIT
+    https://licenses.nuget.org/MIT
 licenseUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
 requireLicenseAcceptance

diff --git a/src/FsUnit.NUnit/sample.paket.template b/src/FsUnit.NUnit/sample.paket.template
@@ -10,7 +10,7 @@ projectUrl
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
 licenseExpression
-    MIT
+    https://licenses.nuget.org/MIT
 licenseUrl
     https://github.com/fsprojects/FsUnit/blob/master/license.txt
 requireLicenseAcceptance

diff --git a/src/FsUnit.Xunit/paket.template b/src/FsUnit.Xunit/paket.template
@@ -10,7 +10,7 @@ projectUrl
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
 licenseExpression
-    MIT
+    https://licenses.nuget.org/MIT
 licenseUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/license.txt
 requireLicenseAcceptance

diff --git a/src/FsUnit.Xunit/sample.paket.template b/src/FsUnit.Xunit/sample.paket.template
@@ -10,7 +10,7 @@ projectUrl
 iconUrl
     https://raw.githubusercontent.com/fsprojects/FsUnit/master/docs/img/logo.png
 licenseExpression
-    MIT
+    https://licenses.nuget.org/MIT
 licenseUrl
     https://github.com/fsprojects/FsUnit/blob/master/license.txt
 requireLicenseAcceptance