aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
authorDierk Koenig <dierk.koenig@canoo.com>2016-01-16 17:06:24 +0100
committerDierk Koenig <dierk.koenig@canoo.com>2016-01-16 17:06:24 +0100
commitb13eca1de3f99592229a56a26a5e92c48ceeeffe (patch)
treed793e164a8498a9c8a4c23c0eeb2e9c977d55267 /README.adoc
parentbf17722a8c08da3802a346f13584474659fdc76b (diff)
downloadfrege-gradle-plugin-b13eca1de3f99592229a56a26a5e92c48ceeeffe.tar.gz
frege-gradle-plugin-b13eca1de3f99592229a56a26a5e92c48ceeeffe.tar.bz2
frege-gradle-plugin-b13eca1de3f99592229a56a26a5e92c48ceeeffe.zip
complete the quickcheck options
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc24
1 files changed, 22 insertions, 2 deletions
diff --git a/README.adoc b/README.adoc
index 5b8f415..c943b48 100644
--- a/README.adoc
+++ b/README.adoc
@@ -26,8 +26,10 @@ apply plugin: "org.frege-lang"
To apply the plugin using the new incubating, plugin mechanism (since Gradle 2.1), add:
```
plugins {
- id "org.frege-lang" version "0.5"
+ id "org.frege-lang" version "0.7"
}
+
+apply plugin: "org.frege-lang"
```
== Tasks
@@ -49,7 +51,25 @@ The plugin adds dependencies so that using the `build` task is typically all tha
== Task Help
-TODO: Add options and descriptions for each task above.
+=== Configuring QuickCheck
+
+Without any configuration, the `fregeQuickCheck` task (which is triggered as part of the `test` task)
+automatically executes all tests from the Frege test source set (default: `src/test/frege`).
+It will pick up all functions as tests that return a value of type `Property`. This is usually achieved by
+using the factory methods `property` or `once`.
+Please see more details under http://www.frege-lang.org/doc/frege/test/QuickCheck.html[QuickCheck API doc].
+
+NOTE: Testing fails if no test is found. If your project does not contain any tests, you have to skip testing via `-x test`.
+
+You can configure the task in many ways. To see all options, you best ask the help:
+```
+fregeQuickCheck {
+ help = true
+}
+```
+
+
+TODO: Add options and descriptions for more tasks from above.
== Example