From 3971b50f5e68e6f3a97397d6d41ada83224e5104 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Galland?= Date: Fri, 30 Sep 2016 10:01:37 +0200 Subject: [PATCH] [doc] Add section for sarl-maven-plugin in the README. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Stéphane Galland --- README.adoc | 34 +++++++++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 0aea5ddb17..c7184e0fcd 100644 --- a/README.adoc +++ b/README.adoc @@ -113,7 +113,39 @@ For using this version, you must add the Maven Repository Server of SARL in your ... ``` -=== 3.4 Syntax highlighting with other tools +=== 3.4. Compile SARL code with Maven + +For compiling SARL source files with Maven, you should use the provided plugin: `sarl-maven-plugin`. +It invokes the SARL and Java compilers with a simpler interface than the standard Xtext maven plugin. +For using the `sarl-maven-plugin`, you should add in your pom file: + +```xml + ... + + + + io.sarl.maven + sarl-maven-plugin + 0.4.1 + true + + 1.8 + 1.8 + UTF-8 + + + ... + + ... + + ... +``` + +Please, replace Version `0.4.1` in the previous snipset by the number of the version you want to use. + +CAUTION: Do not forget to set the `extensions` flag to `true`. + +=== 3.5. Syntax highlighting with other tools Several style specifications are provided for syntax highlighting in third party tools. Style specifications are provided for: