From 47bca2aa98f7cd454257a4969bd45ef7d1208a38 Mon Sep 17 00:00:00 2001 From: Kurt Schelfthout Date: Sun, 3 Mar 2024 10:54:20 +0000 Subject: [PATCH] Update readme. --- README.md | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 69c367de..ca7a9013 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -# What is FsCheck? # +# What is FsCheck? FsCheck is a tool for testing .NET programs automatically. The programmer provides a specification of the program, in the form of properties that functions, methods or objects should satisfy, and FsCheck then tests that the properties hold in a large number of randomly generated cases. While writing the properties, you are writing a testable specification of your program. Specifications are expressed in F#, C# or VB, using combinators defined in the FsCheck library. FsCheck provides combinators to define properties, observe the distribution of test data, and define test data generators. When a property fails, FsCheck automatically displays a minimal counter-example. @@ -9,7 +9,7 @@ Since v0.5, [scalacheck](https://github.com/rickynils/scalacheck) has influenced FsCheck's generator combinators can be used in any testing framework to easily generate random values for many types, and FsCheck itself integrates nicely with existing unit testing frameworks such as NUnit, xUnit, MSTest and MbUnit. -# Releases # +# Releases on Nuget * [FsCheck](http://nuget.org/List/Packages/FsCheck) * [FsCheck.Xunit](http://nuget.org/List/Packages/FsCheck.Xunit) @@ -37,11 +37,11 @@ nuget FsCheck 2.0.4 nuget FsCheck 2.0.5-b247 ``` -# Documentation # +# Documentation * [English](https://fscheck.github.io/FsCheck/) -# Contributing # +# Contributing Pull requests are very welcome! @@ -49,21 +49,23 @@ Check out the issues marked "good first issue" and "help wanted" if you need any We rarely reject PRs. If you intend to make a bigger change, it's better to open an issue first to discuss. -## Building ## +## Development -Check out the project and run build.cmd on Windows or build.sh on Linux/OSX. That should pull in all the dependencies, build and run the tests. +FsCheck uses standard .NET package management via NuGet and is built, tested and packaged via typical usage of `dotnet`. -For Visual Studio/MonoDevelop/Xamarin Studio/VsCode: open (the folder that contains) FsCheck.sln and start coding. +To get started, check out the repository and run `dotnet build` to build. Use `dotnet test .\tests\FsCheck.Test\` to run the tests. If that passes after you've changed some code, you are ready to send a Pull Request! + +For Visual Studio/MonoDevelop/Xamarin Studio/VsCode: open (the folder that contains) FsCheck.sln and start coding. Building and running tests in IDEs should work out of the box. FsCheck uses a build script inspired by FAKE. Run `build.[cmd|sh] -t ` (or `dotnet fsi build.fsx -t `) to do something. Important targets are: -* `Build`: cleanly builds all platforms in Release mode. +* `Build`: cleanly builds in Release mode. * `Tests`: builds and runs the tests. * `Docs`: builds and generates documentation. FsCheck uses FSharp.Formatting, so literate fsx files in the docs folder. * `WatchDocs`: convenient when developing documentation - starts a local webserver and watches for changes in the docs folder. * `NuGetPack`: Creates NuGet packages. * `CI`: Target that is run on AppVeyor, basically all of the above. -## CI ## +## CI AppVeyor [![Build status](https://ci.appveyor.com/api/projects/status/7ytaslpgxxtw7036/branch/master)](https://ci.appveyor.com/project/kurtschelfthout/fscheck)