Просмотр исходного кода

Add basic documentation for Triq plugin

This is based on the documentation of the EUnit plugin.
Krzysztof Jurewicz 7 лет назад
Родитель
Сommit
208a116238
2 измененных файлов с 33 добавлено и 0 удалено
  1. 2 0
      doc/src/guide/book.asciidoc
  2. 31 0
      doc/src/guide/triq.asciidoc

+ 2 - 0
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]

+ 31 - 0
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