From 6346c237e7ee3a412c92f0c1837092bad2d66158 Mon Sep 17 00:00:00 2001
From: "Lange, Dr. Herbert" <herbert.lange@uni-hamburg.de>
Date: Tue, 9 Aug 2022 10:46:18 +0200
Subject: [PATCH] extend the readme

---
 README.md | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 97be315..a1701e3 100644
--- a/README.md
+++ b/README.md
@@ -5,4 +5,11 @@ A simple GUI for running the corpus services based on a YAML configuration
 ## Getting started
 
 This application requires at least JAVA 18 to work. It can be found for download [https://www.oracle.com/java/technologies/downloads/](here).
-Make sure that JAVA is set up properly and in the PATH. Setup instructions for Windows can be found [https://explainjava.com/set-java-path-and-java-home-windows/](here)
\ No newline at end of file
+Make sure that JAVA is set up properly using JAVA_HOME or available in the PATH. Setup instructions for Windows can be found
+[https://explainjava.com/set-java-path-and-java-home-windows/](here)
+
+## Running the GUI
+
+Basic run scripts are included for both Windows (`run-windows.bat`) and Linux (`run-linux.sh`). The script for Mac (`run-mac.sh`) is currently the same
+as the one for Linux and has not been tested.
+
-- 
GitLab