aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authortricktron <tgagnaux@gmail.com>2021-12-21 15:54:51 +0100
committerGitHub <noreply@github.com>2021-12-21 15:54:51 +0100
commit2eeb5f4fe33f325d07988c99c758909c4aaad957 (patch)
tree1edffe9354d85cc4ce4717cda443be17ee1cf8a7 /README.md
parent3c4bfaeb12fc7480782efd5f2f78831ab0761bbb (diff)
parent6fe74444e80d68dffa61e2e57b78092e50a54772 (diff)
downloadfrege-gradle-plugin-2eeb5f4fe33f325d07988c99c758909c4aaad957.tar.gz
frege-gradle-plugin-2eeb5f4fe33f325d07988c99c758909c4aaad957.tar.bz2
frege-gradle-plugin-2eeb5f4fe33f325d07988c99c758909c4aaad957.zip
Merge pull request #17 from tricktron/f-repl-with-source-deps
Repl with all Source Dependencies
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 2c5fb39..89b5751 100644
--- a/README.md
+++ b/README.md
@@ -12,13 +12,14 @@ git clone https://github.com/tricktron/frege-gradle-plugin.git
```
## How to Use
-1. Specify the frege compiler release, version and main module in your `build.gradle`:
+1. Specify the frege compiler release, version, main module and repl source file in your `build.gradle`:
```groovy
frege {
version = '3.25.84'
release = '3.25alpha'
- mainModule = 'my.mod.Name'
+ mainModule = 'my.mod.Name' // see runFrege task
+ replSource = 'Name.fr' // see replFrege task
}
```
@@ -35,7 +36,7 @@ Optional configuration parameters inside `build.gradle`:
- **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`.
-- **replFrege**: Takes care of all project dependencies and prints the command to start the Frege REPL, e.g: `java -cp <your-correct-classpath-with-all-dependencies> frege.repl.FregeRepl`.
+- **replFrege**: Takes care of all project dependencies of the specified filename by `replSource` and prints the command to start the Frege REPL, e.g: `java -cp <your-correct-classpath-with-all-dependencies> frege.repl.FregeRepl`. Afterwards you can load your file into the repl with `:l <absolute path to replSource>`.
### Dependencies