From 59e5aa6a100ad84dd16545d8ef35a80b0af35195 Mon Sep 17 00:00:00 2001 From: Mark Perry Date: Tue, 29 Sep 2015 23:19:01 +1000 Subject: Added doc to readme --- README.adoc | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 54 insertions(+), 11 deletions(-) diff --git a/README.adoc b/README.adoc index 0c2f162..5b8f415 100644 --- a/README.adoc +++ b/README.adoc @@ -1,24 +1,67 @@ = Frege Gradle Plugin -This is the official Gradle plugin to compile Frege projects (https://github.com/Frege/frege). See the example project, https://github.com/mperry/frege-gradle-example, for how to use this plugin. +This is the official Gradle plugin to compile Frege projects (https://github.com/Frege/frege). See the example project (https://github.com/mperry/frege-gradle-example) for examples on the usage of this plugin. + +== Plugin Application + +The gradle plugin portal page for Frege documents how to apply the Frege plugin (https://plugins.gradle.org/plugin/org.frege-lang). + +For applying the plugin in all Gradle versions use: +``` +buildscript { + repositories { + maven { + url "https://plugins.gradle.org/m2/" + } + } + dependencies { + classpath "gradle.plugin.org.frege-lang:frege-gradle-plugin:0.5" + } +} + +apply plugin: "org.frege-lang" +``` + +To apply the plugin using the new incubating, plugin mechanism (since Gradle 2.1), add: +``` +plugins { + id "org.frege-lang" version "0.5" +} +``` + +== Tasks This plugin creates the following tasks: -- compileFrege -- compileTestFrege -- fregeRepl -- fregeQuickCheck -- fregeDoc -- fregeNativeGen -= Usage +* fregeRepl +* fregeQuickCheck +* fregeDoc +* fregeNativeGen +* compileFrege +* compileTestFrege + +The plugin adds dependencies so that using the `build` task is typically all that is required to invoke the `compileFrege` and `compileTestFrege` tasks. These task dependencies include: + +* classes -> compileFrege -> compileJava +* testClasses -> compileTestFrege -> compileTestJava +* test -> fregeQuickCheck -> testClasses + +== Task Help + +TODO: Add options and descriptions for each task above. + +== Example + +See: -See https://plugins.gradle.org/plugin/org.frege-lang +* Plugin application: https://plugins.gradle.org/plugin/org.frege-lang +* Plugin usage: https://github.com/mperry/frege-gradle-example -= Continuous Integration +== Continuous Integration The Travis CI build of this repository is at https://travis-ci.org/Frege/frege-gradle-plugin. -= Snapshots +== Snapshots Snapshot releases are available from the Sonatype repository at https://oss.sonatype.org/content/groups/public/org/frege-lang. -- cgit