From e58faf5604dedf27863cdd32f0285a3f3a0911d2 Mon Sep 17 00:00:00 2001 From: lkrsnik Date: Thu, 21 Mar 2024 16:00:09 +0100 Subject: [PATCH] Added instructions --- .gitignore | 1 + build_instructions.md | 10 ++++++++++ instructions.md | 24 ++++++++++++++++++++++++ 3 files changed, 35 insertions(+) create mode 100644 build_instructions.md create mode 100644 instructions.md diff --git a/.gitignore b/.gitignore index 57e7ecb..8b188eb 100755 --- a/.gitignore +++ b/.gitignore @@ -166,3 +166,4 @@ src/main/resources/translation_external/ src/main/resources/translations_backup/ shade TEMP +data diff --git a/build_instructions.md b/build_instructions.md new file mode 100644 index 0000000..930ec08 --- /dev/null +++ b/build_instructions.md @@ -0,0 +1,10 @@ +# Build a jar + +```shell +mvn package +``` + +# Build executable using Launch4j +- Install Java on Windows +- Run Launch4j (download first) and create executable +- Copy jre from computer to jre folder that should be in the same folder as list.exe diff --git a/instructions.md b/instructions.md new file mode 100644 index 0000000..1972774 --- /dev/null +++ b/instructions.md @@ -0,0 +1,24 @@ +# Instructions + +Instructions on how to run list. + +## Windows + +There are two options. + +### Run list.exe +The easier option is to download list.zip, extract it and run list.exe. + +### Run list.jar +To do this you first need to install the correct version of java (JDK). The program was developed and tested on [JDK Development Kit 21.0.2](https://www.oracle.com/java/technologies/downloads/#java21). +If you already have another version of Java installed you might have to delete previous version before you install this version. + +Secondly, you may run list using `run.bat` which will run `list.jar` for you. + +## Linux +### Run list.jar +Similarly to running list.jar in Windows, you have to first make sure, that you have the appropriate version of Java installed. The program was developed and tested on [JDK Development Kit 21.0.2](https://www.oracle.com/java/technologies/downloads/#java21). +If you already have another version of Java installed you might have to delete previous version before you install this version. + +Next, you may run list using `run.sh` which will run `list.jar` for you. +