Usability improvements

Author: maximiliani

.gitignore

@@ -236,3 +236,4 @@ gradle-app.setting
 
 # End of https://www.toptal.com/developers/gitignore/api/intellij+all,java,macos,gradle,linux
 lib/gemma
+!/plugins/gemma-plugin-0.1.0.jar

README.md

@@ -6,7 +6,6 @@
 
 :warning:
 Not fully tested yet!
-For mapping documents only Gemma is available currently!
 
 The mapping service allows multiple schemas to be uploaded and managed and documents to be mapped over one of them at a time accordingly.
 Therefore, the service is extensible to other mappers, although currently only Gemma, a service that can only map JSON files, is available.
@@ -22,23 +21,18 @@ Dependencies that are needed to build and are not being downloaded via gradle:
 
 ## How to start
 
-> TODO This section is a placeholder. It still needs to be written properly.
+`./gradlew bootRun'`
 
 ### Prerequisites
-
-You might want to take a look at testbed4inf, which should make it easy to satisfy those.
-
-- Gemma
-- Python
-
-### Install Python and Gemma
-```
-sudo apt install -y python3 python3-pip 
-pip3 install xmltodict wget
-```
-
-
-## More information
+Please make sure the application.properties file is configured correctly.
+Espacially the following properties (at the end of the file) are important:
+- `mapping-service.pythonLocation=file:///opt/homebrew/bin/python3` \
+Enter the loacation of your python3 installation. You can determine it by typing `which python3` in your terminal.
+- `mapping-service.mappingsLocation:file:///tmp/mapping-service/` \
+Enter the location where you want to store your mappings. This folder will be created if it does not exist yet.
+
+You might want to add a plugin to make the service working. Normally, there should be a gemma-plugin-x.x.x.jar in the plugins folder.
+If not, you can find its source code [here](https://github.com/maximilianiKIT/gemma-plugin).
 
 ## License