Move build instructions to documentation

Author: gitseti

CONTRIBUTING.md

@@ -7,7 +7,7 @@ our [HiveMQ Community Repo](https://github.com/hivemq/hivemq-community).
 ## Prerequisites
 
 We recommend to develop your changes by using [IntelliJ IDEA](https://www.jetbrains.com/idea/). 
-Therefore, the following guide will focus on creating your changes by using IntelliJ. 
+Therefore, the following guide will focus on creating your changes using IntelliJ. 
 
 Furthermore, the following is needed to make your development efforts as smoothly as possible:
 - A Java 11 JDK (we recommend [temurin](https://adoptium.net/de/temurin/releases/?version=11)) => [Set the JDK in IntelliJ](https://www.jetbrains.com/help/idea/sdk.html)
@@ -53,7 +53,7 @@ Furthermore, the following is needed to make your development efforts as smoothl
 - Implement your changes under `src/main/java`
 - You can use the existing code as a guide
 - The project uses Nullability annotations to avoid NullPointerExceptions: `@NotNull`, `@Nullable`. 
-  Every non-primitive parameter/return type/field should be annotated with one of them.
+  Every non-primitive parameter, return type and field should be annotated with one of them.
 
 ## 4. Write tests
 
@@ -67,10 +67,7 @@ Furthermore, the following is needed to make your development efforts as smoothl
 
 ## 5. Build and test
 
-- Before you build mqtt-cli, make sure that 
-  - a Docker daemon is running
-  - you have installed the native image tooling by using `./gradlew installNativeImageTooling`
-- To build mqtt-cli use `./gradlew build`
+- See [Building from source](https://hivemq.github.io/mqtt-cli/docs/installation/#building-from-source) for instructions on how to build mqtt-cli
 - Before proceeding to the next step, please make sure that your changes build and all tests succeed
 - Tip: After building mqtt-cli you can execute the cli by using the generated jar file `java -jar build/libs/mqtt-cli-<version>.jar` (you can also just build this jar by using `./gradlew shadowJar`)
 - Tip: To quickly test your changes manually you can directly execute commands from your IDE by going to <i>Run > Edit Configurations...</i> and adding your cli arguments
@@ -80,6 +77,7 @@ Furthermore, the following is needed to make your development efforts as smoothl
 
 ## 6. Commit and Push
 - Before committing execute `./gradlew licenseFormat` to add license headers to each file
+- [Reformat each changed file](https://www.jetbrains.com/help/idea/reformat-and-rearrange-code.html#reformat_file) using the .editorconfig settings of the project
 - Commit your changes directly from IntelliJ by pressing `Command` + `K` OR via the command `git commit -m "your commit mesage"`
   - Commits should be as atomic as possible
   - Commit messages should describe the changes clearly

README.md

@@ -7,6 +7,7 @@
 [![GitHub Release](https://img.shields.io/github/v/release/hivemq/mqtt-cli?style=for-the-badge)](https://github.com/hivemq/mqtt-cli/releases)
 [![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/hivemq/mqtt-cli/.github/workflows/check.yml?branch=master&style=for-the-badge)](https://github.com/hivemq/mqtt-cli/actions/workflows/check.yml?query=branch%3Amaster)
 [![CLI Downloads](https://img.shields.io/github/downloads/hivemq/mqtt-cli/total?style=for-the-badge)](https://github.com/hivemq/mqtt-cli/releases)
+[![CLI License](https://img.shields.io/github/license/hivemq/mqtt-cli?style=for-the-badge)](https://github.com/hivemq/mqtt-cli/blob/develop/LICENSE)
 
 <i>mqtt-cli</i> is a <b>feature-rich MQTT Command Line Interface</b>.
 
@@ -18,14 +19,15 @@
 [Subscribe](#subscribe) •
 [Shell](#shell) •
 [Test](#test) •
-[How to contribute](#how-to-contribute)
+[How to Contribute](#how-to-contribute)
 
 
 </div>
 
 ## Getting Started
 
 - [Installation instructions](https://hivemq.github.io/mqtt-cli/docs/installation/) 
+- [Building from source](https://hivemq.github.io/mqtt-cli/docs/installation/#building-from-source) 
 - [Full documentation](https://hivemq.github.io/mqtt-cli)
 
 ## Publish
@@ -63,6 +65,6 @@
 <img align="center" src="./img/test.gif"/>
 
 
-## How to contribute
+## How to Contribute
 - If you want to request a feature or report a bug, please [create a GitHub Issue using one of the provided templates](https://github.com/hivemq/mqtt-cli/issues/new/choose)
 - If you want to make a contribution to the project, please have a look at the [contribution guide](CONTRIBUTING.md)

docs/_docs/installation.md

@@ -77,11 +77,33 @@ sudo yum install -y https://github.com/hivemq/mqtt-cli/releases/download/v4.11.0
 
 ## Building from source
 
-The MQTT CLI project uses [Gradle](https://gradle.org/) to build. A gradle wrapper configuration is included, so that after cloning the 
-[repository](https://github.com/hivemq/mqtt-cli) from GitHub, you can simply change into the directory containing the project and execute 
+- mqtt-cli uses [Gradle](https://gradle.org/) to build.
+- To be able to execute integration tests a running **Docker environment** is required
+- To be able to build and test the native image a **GraalVM installation** is required. You can set it up
+  with ``$ ./gradlew installNativeImageTooling``.
 
-```
-./gradlew build
-```
+To do a clean build, issue the following command:
+`$ ./gradlew clean build`
+
+This runs the unit tests and compiles a new mqtt-cli-<version>.jar into build/libs.
+You can then update an existing MQTT CLI installation by replacing its mqtt-cli-<version>.jar with this one.
+
+The `build.gradle.kts` file contains further instructions for building the platform specific distribution packages.
+In a nutshell:
+
+For MacOS/Linux brew:
+`$ ./gradlew buildBrewFormula`
+
+For the Debian package:
+`$ ./gradlew buildDebianPackage`
+
+For the RPM package:
+`$ ./gradlew buildRpmPackage`
+
+For the Windows installer:
+`$ ./gradlew buildWindowsZip`
+
+For building a local docker image:
+`$ ./gradlew jibDockerBuild`