# [Kotlin](https://kotlinlang.org/) Example Project for [b<span style="color:orange">l</span>d](https://rife2.com/bld)

Template for [bld](https://rife2.com/bld) projects using the [Kotlin extension](https://github.com/rife2/bld-kotlin) with built-in support for the [Dokka](https://github.com/rife2/bld-dokka) and [Detekt](https://github.com/rife2/bld-detekt) extensions.

## Compile the Example

```console
./bld compile
```

## Run the Example

```console
./bld run
```

## Run the Tests

```console
./bld test
```

## Check the Example with [Detekt](https://detekt.dev/)

```console
./bld detekt
```

## Build the documentation with [Dokka](https://github.com/Kotlin/dokka)

```console
./bld javadoc
./bld dokka-html
./bld dokka-gfm
./bld dokka-jekyll
```

## Requirements

- A Kotlin compiler must be [installed](https://github.com/rife2/bld-kotlin?tab=readme-ov-file#kotlin-compiler-requirement).