Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
c-cube committed Sep 18, 2018
1 parent 5ab3937 commit 24694d7
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ or an error number otherwise.

http://ounit.forge.ocamlcore.org/[OUnit] is a popular unit-testing framework
for OCaml.
QCheck provides a sub-library `qcheck.ounit` with some helpers, in `QCheck_ounit`,
QCheck provides a sub-library `qcheck-ounit` with some helpers, in `QCheck_ounit`,
to convert its random tests into OUnit tests that can be part of a wider
test-suite.

Expand All @@ -321,7 +321,10 @@ let _ =
----

=== Integration with alcotest
NOTE: the package `qcheck` contains the module `QCheck_runner`
which contains both custom runners and OUnit-based runners.

=== Integration within alcotest

https://github.com/mirage/alcotest/[Alcotest] is a simple and colorful test framework for
OCaml. QCheck now provides a sub-library `qcheck-alcotest` to
Expand Down Expand Up @@ -353,3 +356,19 @@ let () =
]
----

=== Compatibility notes

Starting with 0.9, the library is split into several components:

- `qcheck-core` depends only on unix and bytes. It contains the module
`QCheck` and a `QCheck_base_runner` module with our custom runners.
- `qcheck-ounit` provides an integration layer for `OUnit`
- `qcheck` provides a compatibility API with older versions of qcheck,
using both `qcheck-core` and `qcheck-ounit`.
It provides `QCheck_runner` which is similar to older versions and contains
both custom and Ounit-based runners.
- `qcheck-alcotest` provides an integration layer with `alcotest`

Normally, for contributors,
`opam pin https://github.com/c-cube/qcheck` will pin all these packages.

0 comments on commit 24694d7

Please sign in to comment.