Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
kurtschelfthout committed Mar 3, 2024
1 parent 570ac11 commit 47bca2a
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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)
Expand Down Expand Up @@ -37,33 +37,35 @@ 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!

Check out the issues marked "good first issue" and "help wanted" if you need any inspiration.

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 <Target>` (or `dotnet fsi build.fsx -t <Target>`) 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)

0 comments on commit 47bca2a

Please sign in to comment.