kotlin-bld-example/README.md

36 lines
721 B
Markdown

# [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 Dokka and the [Detekt extension](https://github.com/rife2/bld-detekt).
## 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
```