From 2b2b16037a7a2083a6929c20fbf8ac25763f8ec7 Mon Sep 17 00:00:00 2001
From: Thibault Gagnaux <tgagnaux@gmail.com>
Date: Tue, 20 Jul 2021 17:10:51 +0200
Subject: chore: adds readme

---
 README.md | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 README.md

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
-- 
cgit