diff --git a/README.md b/README.md index 97be315076f8c727023a86e2eba3a0cfce044483..a1701e3161b5648ba08b0143249eaa067ff05e98 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. +