Added instructions

This commit is contained in:
lkrsnik 2024-03-21 16:00:09 +01:00
parent 9bb9c5669d
commit e58faf5604
3 changed files with 35 additions and 0 deletions

1
.gitignore vendored
View File

@ -166,3 +166,4 @@ src/main/resources/translation_external/
src/main/resources/translations_backup/
shade
TEMP
data

10
build_instructions.md Normal file
View File

@ -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

24
instructions.md Normal file
View File

@ -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.