Add examples (#12)

* added examples; moved to xunit.v3

* changelog update

* added README link

* added MTP entry to global.json

Author: Martin521

CHANGELOG.md

@@ -1,5 +1,15 @@
 # CHANGELOG
 
+## 1.0.10
+
+### added
+
+* documentation examples
+
+### changed
+
+* moved to xunit.v3
+
 ## 1.0.9
 
 * changed global and target framework to net10

README.md

@@ -15,7 +15,7 @@ The source file can contain directives to reference libraries and to influence t
 
 Because of a) concerns of parts of the F# community about having two similar tools (`dotnet fsi script.fsx` and `dotnet runfs app.fs`) and b) missing "market pull", I have currently no further plans for this project.
 
-The tool is still available as dotnet tool and can be useful especially for ad-hoc testing of library projects.
+The tool is still available as dotnet tool and can be useful especially for [ad-hoc testing of library projects](docs/examples/testing/README.md).
 
 ## Usage
 

docs/examples/testing/README.md

@@ -0,0 +1,10 @@
+# Using runfs for library testing
+
+## Explorative testing
+
+Just create an ad-hoc driver file (see example file `explore.fs` in this directory), add a project reference and start testing your library API by running `dotnet runfs explore.fs`.
+
+## Unit test development / fixes
+
+Rather than building a test project, discovering the tests, selecting the one you are interested in and running it, you just add the project reference and the test framework package reference to the test file you are interested in (see example file `tests.fs`, using xunit.v3) and run it with runfs (here: `dotnet runfs tests.fs`).
+

docs/examples/testing/explore.fs

@@ -0,0 +1,5 @@
+#r_project "D:/fsharp/projects/div/Runfs/docs/examples/testing/mylib/mylib.fsproj"
+
+open Mylib
+
+printfn $"Hello {x}"

docs/examples/testing/mylib/Directory.Build.props

@@ -0,0 +1,5 @@
+<Project>
+  <PropertyGroup>
+    <UseArtifactsOutput>true</UseArtifactsOutput>
+  </PropertyGroup>
+</Project>

docs/examples/testing/mylib/Library.fs

@@ -0,0 +1,3 @@
+module Mylib
+
+let x = 42

docs/examples/testing/mylib/mylib.fsproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net10.0</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <Compile Include="Library.fs" />
+  </ItemGroup>
+
+</Project>

docs/examples/testing/tests.fs

@@ -0,0 +1,13 @@
+module Mylib.Tests
+
+#r_package "xunit.v3.mtp-v2@3.2.2"
+#r_project "mylib/mylib.fsproj"
+
+#nowarn 988
+
+open Xunit
+open Mylib
+
+[<Fact>]
+let test1 () =
+    Assert.Equal(x, 42)

global.json

@@ -3,5 +3,8 @@
     "version": "10.0.100",
     "rollForward": "latestMinor",
     "allowPrerelease": false
+  },
+  "test": {
+    "runner": "Microsoft.Testing.Platform"
   }
-}
+}

src/Runfs/Runfs.fsproj

@@ -2,7 +2,7 @@
   <PropertyGroup>
     <!-- General -->
     <AssemblyName>Runfs</AssemblyName>
-    <Version>1.0.9</Version>
+    <Version>1.0.10</Version>
     <Description>"dotnet run app.cs" functionality for F#.</Description>
     <Copyright>Copyright 2025 by Martin521</Copyright>
     <Authors>Martin521 and contributors</Authors>
@@ -15,12 +15,15 @@
     <PackAsTool>True</PackAsTool>
     <ToolCommandName>runfs</ToolCommandName>
     <PackageReleaseNotes>
-## 1.0.9
+## 1.0.10
+
+### added
+
+* documentation examples
 
 ### changed
 
-* changed global and target framework to net10
-* updated README
+* moved to xunit.v3
     </PackageReleaseNotes>
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <PackageIcon>