diff options
| -rw-r--r-- | README.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f909cf7 --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Frege Gradle Plugin + +Compile frege code with gradle. + +## Installation + +```bash +git clone https://github.com/tricktron/frege-gradle-plugin.git +./gradlew publishToMavenLocal +``` + +## How to Use +1. Specify the frege compiler release and version in your `build.gradle`: + +```groovy +frege { + version = '3.25.84' + release = '3.25alpha' +} +``` + +See the [frege releases](https://github.com/Frege/frege/releases) for all available versions. + +2. Run the newly added `compileFrege` task. All your `*.fr` files get compiled to `build/classes/frege`. + +## 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 |