From 3a5256513e59c59daf31d68cb210dfd33d93423a Mon Sep 17 00:00:00 2001 From: Patrik Date: Wed, 14 Aug 2024 12:14:45 +0200 Subject: [PATCH] Improve readme #375 --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 303252b1..487b56e3 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,11 @@ It stands for _**Ko**tlin_ _**La**nguage_ _**Su**pport_. Kolasu is part of the [StarLasu](https://github.com/Strumenta/StarLasu) set of libraries. The other libraries provide similar support in other languages such as Typescript and Python. +## Prerequisites + +- JDK 8, 11, and 17 available on your system +- Docker environment + ## JDK supported We support JDK 8, 11, and 17. All JDKs in between should work too, but these are explicitly tested. @@ -68,6 +73,20 @@ dependencies { } ``` +## Building and Testing + +To build the project, run: + +``` +./gradlew build +``` + +To run all tests, use: + +``` +./gradlew allTest +``` + ## How to format code Run: