diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index cf93d4d6b..0c63a9afc 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -6,14 +6,18 @@ discussion. ## Development -Check out this repo with Android Studio. It's a standard gradle project and conventional to checkout. +Check out this repo with Android Studio. It's a standard gradle project and conventional to +checkout. + +Circuit is a Kotlin Multiplatform project, so ensure you have your environment set up +accordingly: https://www.jetbrains.com/help/kotlin-multiplatform-dev/multiplatform-setup.html The primary project is `circuit`. The primary sample is `samples/star`. This project is written in Kotlin and should only use Kotlin. -Code formatting is checked via [Spotless](https://github.com/diffplug/spotless). To run the formatter, -use the `spotlessApply` command. +Code formatting is checked via [Spotless](https://github.com/diffplug/spotless). To run the +formatter, use the `spotlessApply` command. ```bash ./gradlew spotlessApply