From 941575d1524bca01f9fc3826fc10eb9e7adf5a79 Mon Sep 17 00:00:00 2001 From: mnhock Date: Sat, 22 Jun 2024 07:34:10 +0200 Subject: [PATCH] Update README.md --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 733fb4a..e9912a7 100644 --- a/README.md +++ b/README.md @@ -81,4 +81,26 @@ Explore the complete [documentation](https://github.com/enofex/taikai/blob/main/ ## Contributing -Interested in contributing? Check out our [Contribution Guidelines](https://github.com/enofex/taikai/blob/main/CONTRIBUTING.md) for details on how to get involved. +Interested in contributing? Check out our [Contribution Guidelines](https://github.com/enofex/taikai/blob/main/CONTRIBUTING.md) for details on how to get involved. Note, that we expect everyone to follow the [code of conduct](https://github.com/enofex/taikai/blob/main/CODE_OF_CONDUCT.md). + +### What you will need + +* Git +* Java 21 or higher + +### Get the Source Code + +Clone the repository + +```shell +git clone git@github.com:enofex/taikai.git +cd taikai +``` + +### Build the code + +To compile, test, and build + +```shell +./mvnw -B +```