Bug 541654: [R-Help] Add readme for R help server
Change-Id: Ibb85da32cbe38ba236e68bdd16598553bc20cd20
diff --git a/rhelp/org.eclipse.statet.rhelp.server/README.md b/rhelp/org.eclipse.statet.rhelp.server/README.md
new file mode 100644
index 0000000..15c029d
--- /dev/null
+++ b/rhelp/org.eclipse.statet.rhelp.server/README.md
@@ -0,0 +1,45 @@
+# Eclipse StatET - R Help Server
+
+## Requirements
+
+ * Java
+ * RJSrv
+
+## Configuration
+
+Edit the configuration(s) for the R environments in the folder `renvs`:
+ - One configuration file per R environment
+ - The name of the file is the id of the R environment
+
+The server is based on Spring Boot; see documentation of Spring Boot e.g. how
+to configure the webserver.
+
+## Run the Server
+
+To run the server just start the jar:
+
+ java -jar org.eclipse.statet.rhelp.server.jar &
+
+### Special modes
+ * `-index-and-exit` - creates or updates the help index only
+
+## Access the Server
+
+### URI for API
+The URI to access the help of an R environment via IDE is specified as follows:
+
+ http://<name or ip>:<port>/<env id>
+
+For example: `http://serverwithhelp:8080/r35`
+
+The following defaults can be optionally omitted:
+ - `<port>` = 80
+ - `<env id>` = default
+
+So `http://serverwithhelp/` is equal to `http://serverwithhelp:80/default`.
+
+### Web
+The URL to access the help using a webbrowser is:
+
+ http://<name or ip>:<port>/rhelp/browse/<env id>
+
diff --git a/rhelp/org.eclipse.statet.rhelp.server/src/assembly/distr-bin.xml b/rhelp/org.eclipse.statet.rhelp.server/src/assembly/distr-bin.xml
index 4546ae0..01fe1bc 100644
--- a/rhelp/org.eclipse.statet.rhelp.server/src/assembly/distr-bin.xml
+++ b/rhelp/org.eclipse.statet.rhelp.server/src/assembly/distr-bin.xml
@@ -22,6 +22,7 @@
<outputDirectory></outputDirectory>
<includes>
<include>renvs/**</include>
+ <include>README.md</include>
</includes>
</fileSet>
<fileSet>
