aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThibault Gagnaux <tgagnaux@gmail.com>2021-11-10 09:31:00 +0100
committerThibault Gagnaux <tgagnaux@gmail.com>2021-11-10 09:31:00 +0100
commitf3924e8748efe3b035a43ec62eb1ab54179c6221 (patch)
tree52ad47aa09a66506f9f99d5aefbfdef969cf9086
parenta5bdb321ebff31e5b2005c6b511fc3873ec9cc7f (diff)
downloadfrege-gradle-plugin-f3924e8748efe3b035a43ec62eb1ab54179c6221.tar.gz
frege-gradle-plugin-f3924e8748efe3b035a43ec62eb1ab54179c6221.tar.bz2
frege-gradle-plugin-f3924e8748efe3b035a43ec62eb1ab54179c6221.zip
chore: updates junit 5.7.2 -> 5.8.1, README and version
-rw-r--r--.github/workflows/build.yml (renamed from .github/workflows/main.yml)0
-rw-r--r--README.md24
-rw-r--r--build.gradle2
-rw-r--r--gradle.properties2
4 files changed, 22 insertions, 6 deletions
diff --git a/.github/workflows/main.yml b/.github/workflows/build.yml
index c82e9d6..c82e9d6 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/build.yml
diff --git a/README.md b/README.md
index f909cf7..76b42c5 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,8 @@
# Frege Gradle Plugin
-Compile frege code with gradle.
+![build](https://github.com/tricktron/frege-gradle-plugin/actions/workflows/build.yml/badge.svg)
+
+Simplifies setting up your Frege project.
## Installation
@@ -10,18 +12,32 @@ git clone https://github.com/tricktron/frege-gradle-plugin.git
```
## How to Use
-1. Specify the frege compiler release and version in your `build.gradle`:
+1. Specify the frege compiler release, version and main module in your `build.gradle`:
```groovy
frege {
version = '3.25.84'
release = '3.25alpha'
+ mainModule = 'my.mod.Name'
}
```
-See the [frege releases](https://github.com/Frege/frege/releases) for all available versions.
+See the [Frege Releases](https://github.com/Frege/frege/releases) for all available versions.
+
+Optional configuration parameters inside `build.gradle`:
+- compilerDownloadDir: defaults to `<projectRoot>/lib`
+- mainSourceDir: defaults to `<projectRoot>/src/main/frege`
+- outputDir: defaults to `<projectRoot>/build/classes/main/frege`
+
+
+
+
+### 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`.
-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
diff --git a/build.gradle b/build.gradle
index a30daed..f64913d 100644
--- a/build.gradle
+++ b/build.gradle
@@ -45,7 +45,7 @@ tasks.withType(Test).configureEach {
dependencies {
def junit5Group = 'org.junit.jupiter'
- def junit5Version = '5.7.2'
+ def junit5Version = '5.8.1'
testImplementation group: junit5Group, name: 'junit-jupiter-api', version: junit5Version
testRuntimeOnly group: junit5Group, name: 'junit-jupiter-engine', version: junit5Version
}
diff --git a/gradle.properties b/gradle.properties
index cae3d07..52f90fe 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -1,2 +1,2 @@
group = ch.fhnw.thga
-version = 1.0.0-alpha \ No newline at end of file
+version = 1.1.0-alpha \ No newline at end of file