update readme

2024-08-06 10:14:06 +02:00 · 2024-08-06 10:14:06 +02:00 · 059b445e01
commit 059b445e01
parent bc14aa40fe
1 changed files with 17 additions and 6 deletions
--- a/readme.md
+++ b/readme.md
@ -16,6 +16,17 @@
 | Windows   | 🟠 limited |
 | GNU/Linux | 🟠 limited |
  
+## building  
+**required tools**  
+ - java 17 sdk  
+ - git  
+ - maven  
+  
+**build steps**  
+clone the official repository linked below using `git clone`.
+`cd` into the directory and run `mvn clean package`.
+you will find a runnable jar with dependencies in the `target/` folder.
+  
 ## support  
 | category            | info                                                   |
 |---------------------|--------------------------------------------------------|