From 208a116238e0881ffde8702021c2d0e404a5b336 Mon Sep 17 00:00:00 2001
From: Krzysztof Jurewicz <krzysztof.jurewicz@gmail.com>
Date: Sun, 3 Jun 2018 20:19:54 +0200
Subject: Add basic documentation for Triq plugin

This is based on the documentation of the EUnit plugin.
---
 doc/src/guide/book.asciidoc |  2 ++
 doc/src/guide/triq.asciidoc | 31 +++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 doc/src/guide/triq.asciidoc

(limited to 'doc')

diff --git a/doc/src/guide/book.asciidoc b/doc/src/guide/book.asciidoc
index 085c147..4e42234 100644
--- a/doc/src/guide/book.asciidoc
+++ b/doc/src/guide/book.asciidoc
@@ -52,6 +52,8 @@ include::eunit.asciidoc[EUnit]
 
 include::common_test.asciidoc[Common Test]
 
+include::triq.asciidoc[Triq]
+
 include::coverage.asciidoc[Code coverage]
 
 include::ci.asciidoc[Continuous integration]
diff --git a/doc/src/guide/triq.asciidoc b/doc/src/guide/triq.asciidoc
new file mode 100644
index 0000000..db69860
--- /dev/null
+++ b/doc/src/guide/triq.asciidoc
@@ -0,0 +1,31 @@
+[[triq]]
+== Triq
+
+https://triq.gitlab.io/[Triq] is a QuickCheck-like library for
+property-based testing. Erlang.mk automates discovery and checking of
+Triq properties.
+
+To run all tests (including Triq):
+
+[source,bash]
+$ make tests
+
+To run all tests and static checks (including Triq):
+
+[source,bash]
+$ make check
+
+You can also run Triq separately:
+
+[source,bash]
+$ make triq
+
+To check properties from a single module:
+
+[source,bash]
+$ make triq t=foo_tests
+
+To check a single property:
+
+[source,bash]
+$ make triq t=foo_tests:bar
-- 
cgit v1.2.3