Version 0.3.2

Version 0.3.2

pages/docs/adding.md

@@ -51,7 +51,7 @@ You might need to add another task for [compiling relast specifications](#compil
 
 ## Build from source
 
-If you want to use `RagConnect`, the currently suggested way is to first build the jar from the [RagConnect repository](https://git-st.inf.tu-dresden.de/jastadd/ragconnect):
+If you want to plan to extend `RagConnect`, the suggested way is to first build the jar from the [RagConnect repository](https://git-st.inf.tu-dresden.de/jastadd/ragconnect) (if you only want to _use_ it, consider using [the packaged version](#use-packaged-version)).
 
 ```bash
 git clone https://git-st.inf.tu-dresden.de/jastadd/ragconnect.git
@@ -60,14 +60,17 @@ cd ragconnect
 ls ragconnect.base/build/libs/
 ```
 
-This `ragconnect-<version>.jar` can then be copied to your project. Please note, that you can safely use `ragconnect.jar` as filename, because the version can always be printed using `java -jar path/to/ragconnect.jar --version`.
+This `ragconnect-<version>.jar` can then be copied to your project.
+Please note, that you can safely use `ragconnect.jar` as filename, because the version can always be printed using `java -jar path/to/ragconnect.jar --version`.
 
 ```bash
 cp ragconnect.base/build/libs/ragconnect-<version>.jar ../your-project/libs/ragconnect.jar
 cd ../your-project/
 ```
 
-Finally, this jar has to be integrated into your build process. In case, [Gradle](https://gradle.org/) is used, a task could look like the following (example taken from the [ros2rag usecase](https://git-st.inf.tu-dresden.de/jastadd/ros2rag)). The path to the jar file may need to be changed according to your project structure.
+Finally, this jar has to be integrated into your build process.
+In case, [Gradle](https://gradle.org/) is used, a task could look like the following (example taken from the [ros2rag use case](https://git-st.inf.tu-dresden.de/jastadd/ros2rag)).
+The path to the jar file may need to be changed according to your project structure.
 
 ```groovy
 task ragConnect(type: JavaExec) {
@@ -87,9 +90,12 @@ task ragConnect(type: JavaExec) {
 
 You might need to add another task for [compiling relast specifications](#compiling-relast-specifications).
 
-## Compiling RelAst specifications
+# Compiling RelAst specifications
 
-The task to compile `RagConnect` specifications is typically accompanied with a task to invoke the [RelAst compiler](http://relational-rags.eu/) and the [JastAdd gradle plugin](https://plugins.gradle.org/plugin/org.jastadd). The additional arguments `--useJastAddNames`, `--listClass`, `--jastAddList` and `--resolverHelper` to relast are not required. Please see the user manual of the RelAst compiler for more information.
+The task to compile `RagConnect` specifications is typically accompanied by a task to invoke the [RelAst compiler](http://relational-rags.eu/) and the [JastAdd gradle plugin](https://plugins.gradle.org/plugin/org.jastadd).
+Currently, the parameter `--useJastAddNames` is **required**, and it may cause incompatibilities if not set.
+The additional arguments `--listClass`, `--jastAddList` and `--resolverHelper` to relast are not required.
+Please see the user manual of the RelAst compiler for more information.
 
 ```groovy
 task relastToJastAdd(type: JavaExec) {
@@ -118,13 +124,3 @@ One also has to specify the dependencies to get correct ordering of tasks.
 generateAst.dependsOn relastToJastAdd
 relastToJastAdd.dependsOn ragConnect
 ```
-
-## Introduced dependencies
-
-RagConnect itself does not introduce dependencies.
-However, depending on the selected protocols (see [compiler options](using#compiler-options)), additional dependencies are required.
-
-| Protocol | Dependency (Gradle format) | Remarks |
-|-|-|-|
-| `mqtt` | `group: 'org.fusesource.mqtt-client', name: 'mqtt-client', version: '1.15'` | Mqtt is selected by default, so this dependency therefore is required "by default". Might work with other versions as well. |
-| `rest` | `group: 'com.sparkjava', name: 'spark-core', version: '2.9.2'` | Might work with other versions as well. For debugging, it is beneficial to include an implementation for [SLF4J](http://www.slf4j.org/). |