aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThibault Gagnaux <tgagnaux@gmail.com>2021-11-24 08:24:49 +0100
committerThibault Gagnaux <tgagnaux@gmail.com>2021-11-24 08:24:49 +0100
commit4f287790c285a1503bc05d75e1561de122f9a79e (patch)
treecba72d09b6e2a09464c7e93a195040b4fcc863dc
parent438bcfecbe73e401e86179ae0d49792f1fc7af34 (diff)
downloadfrege-gradle-plugin-4f287790c285a1503bc05d75e1561de122f9a79e.tar.gz
frege-gradle-plugin-4f287790c285a1503bc05d75e1561de122f9a79e.tar.bz2
frege-gradle-plugin-4f287790c285a1503bc05d75e1561de122f9a79e.zip
chore: updates readme
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index e7a9588..df2e101 100644
--- a/README.md
+++ b/README.md
@@ -36,6 +36,20 @@ Optional configuration parameters inside `build.gradle`:
- **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`.
+### Compile Dependencies
+
+Compile dependencies can be configured as expected in your `build.gradle` file, using the `implementation` scope, e.g.:
+
+```groovy
+repositories {
+ # Add your Frege repo here
+}
+
+dependencies {
+ implementation 'org.frege-lang:fregefx:0.8.2-SNAPSHOT'
+}
+```
+
### 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`.