Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme #375 #376

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve readme #375 #376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down