aboutsummaryrefslogtreecommitdiffstats
path: root/doc/src/guide
diff options
context:
space:
mode:
Diffstat (limited to 'doc/src/guide')
-rw-r--r--doc/src/guide/book.asciidoc2
-rw-r--r--doc/src/guide/proper.asciidoc31
2 files changed, 33 insertions, 0 deletions
diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc
index 0737bca..fa31fe3 100644
--- a/doc/src/guide/book.asciidoc
+++ b/doc/src/guide/book.asciidoc
@@ -54,6 +54,8 @@ include::eunit.asciidoc[EUnit]
include::common_test.asciidoc[Common Test]
+include::proper.asciidoc[PropEr]
+
include::triq.asciidoc[Triq]
include::coverage.asciidoc[Code coverage]
diff --git a/doc/src/guide/proper.asciidoc b/doc/src/guide/proper.asciidoc
new file mode 100644
index 0000000..37fa3d7
--- /dev/null
+++ b/doc/src/guide/proper.asciidoc
@@ -0,0 +1,31 @@
+[[proper]]
+== PropEr
+
+https://proper-testing.github.io/[PropEr] is a QuickCheck-like library for
+property-based testing. Erlang.mk automates discovery and checking of
+PropEr properties.
+
+To run all tests (including PropEr):
+
+[source,bash]
+$ make tests
+
+To run all tests and static checks (including PropEr):
+
+[source,bash]
+$ make check
+
+You can also run PropEr separately:
+
+[source,bash]
+$ make proper
+
+To check properties from a single module:
+
+[source,bash]
+$ make proper t=foo_tests
+
+To check a single property:
+
+[source,bash]
+$ make proper t=foo_tests:bar