aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThibault Gagnaux <tgagnaux@gmail.com>2021-11-17 09:50:12 +0100
committerThibault Gagnaux <tgagnaux@gmail.com>2021-11-17 09:50:12 +0100
commit8c987f0a58470953dc3ac1b9cdff1ac55aaa4e81 (patch)
treeba99639e0c4013daf8c71a98f3f55fd8f2bb2d90 /README.md
parentc093758e568cb14ba482f90f1fa513dc15d846a1 (diff)
downloadfrege-gradle-plugin-8c987f0a58470953dc3ac1b9cdff1ac55aaa4e81.tar.gz
frege-gradle-plugin-8c987f0a58470953dc3ac1b9cdff1ac55aaa4e81.tar.bz2
frege-gradle-plugin-8c987f0a58470953dc3ac1b9cdff1ac55aaa4e81.zip
feat: Adds incremental build and build cache support for the `fregeCompile` task
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/README.md b/README.md
index db18bea..e7a9588 100644
--- a/README.md
+++ b/README.md
@@ -30,15 +30,16 @@ Optional configuration parameters inside `build.gradle`:
- outputDir: defaults to `<projectRoot>/build/classes/main/frege`
- compilerFlags: defaults to `['-O', '-make']`
-
-
-
### Added Tasks
- **setupFrege**: Downloads the specified version of the Frege compiler.
- **compileFrege**: All your `*.fr` files in `mainSourceDir` get compiled to `outputDir`.
- **runFrege**: Runs the Frege module specified by `mainModule`. Alternatively you can also pass the main module by command line, e.g: `gradle runFrege --mainModule=my.mod.Name`.
+### Build Cache
+
+The `compileFrege` task supports incremental builds from build cache. Enable the build cache by setting `org.gradle.caching=true` in your `gradle.properites`.
+
## How to Contribute
Try to add another task, e.g. `fregeDoc` to the [FregePluginFunctionalTest.java](src/functionalTest/java/ch/fhnw/thga/gradleplugins/FregePluginFunctionalTest.java) file and try to make the test pass. \ No newline at end of file