Skip to content

Commit add8267

Browse files
authored
🌍 #119 Some refinements to readme (#121)
1 parent 0fe3935 commit add8267

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# GalaxyCheck
22

3-
GalaxyCheck is a modern property-based testing framework for .NET, in a similar vein to [FsCheck](https://github.com/fscheck/FsCheck). Although GalaxyCheck has been more directly influenced by [fast-check](https://github.com/dubzzz/fast-check), [jqwik](https://github.com/jlink/jqwik) is and [Hedgehog](https://github.com/hedgehogqa/fsharp-hedgehog).
3+
GalaxyCheck is a modern property-based testing framework for .NET, in a similar vein to [FsCheck](https://github.com/fscheck/FsCheck). Although GalaxyCheck has been more directly influenced by [fast-check](https://github.com/dubzzz/fast-check), [jqwik](https://github.com/jlink/jqwik) and [Hedgehog](https://github.com/hedgehogqa/fsharp-hedgehog).
44

5-
The library heavily leans on LINQ expressions, allowing seamless between test-data generators and properties.
5+
The library heavily leans on LINQ expressions, allowing seamless integration between generators and properties. In GalaxyCheck, properties _are_ simply generators of tests.
66

77
[![Nuget](https://img.shields.io/nuget/v/galaxycheck)](https://www.nuget.org/packages/GalaxyCheck/)
88

99
## Quickstart
1010

11-
The recommend way to getting started quickly with GalaxyCheck, is through [xunit](https://github.com/xunit/xunit), and using the integration package, [GalaxyCheck.Xunit](https://www.nuget.org/packages/GalaxyCheck.Xunit/).
11+
The recommended way to getting started quickly with GalaxyCheck, is with [xunit](https://github.com/xunit/xunit), and using the integration package [GalaxyCheck.Xunit](https://www.nuget.org/packages/GalaxyCheck.Xunit/).
1212

1313
```csharp
1414
using GalaxyCheck;
@@ -23,8 +23,6 @@ public class AboutSort
2323
}
2424
```
2525

26-
GalaxyCheck makes randomly-generated lists of integers available to the test function, to prove its correctness over many iterations and a high variance of input.
27-
2826
## Notable features
2927

3028
### Shrinking
@@ -81,7 +79,7 @@ public static IGen<(int x, int y)> Point =>
8179
select (x, y);
8280
```
8381

84-
Hooooold up. Requirements have changed. We actually now need to generate a range, and the interesting thing about the kind of range is that the minimum and maximum bounds need to be in order
82+
Hooooold up. Requirements have changed. We actually now need to generate a range, and the interesting thing about a range is that the minimum and maximum bounds need to be in order.
8583

8684
This would be a significant structural change in some other frameworks, but using LINQ, it's trivial:
8785

@@ -111,7 +109,7 @@ Other frameworks have similar features, though often only supply you with the or
111109

112110
GalaxyCheck encodes the exact iteration and the exact shrink into the replay, which means starting the debugger will take you straight there.
113111

114-
### Visibility
112+
### Transparency
115113

116114
Other frameworks provide sampling functionality, but it can be quite disruptive to get at whilst you're in there writing properties. GalaxyCheck provides a `SampleAttribute`, which can be hot-swapped with `PropertyAttribute`, so you can immediately get an intuition of what values your function is being called with.
117115

0 commit comments

Comments
 (0)