chore(readme): update

This commit is contained in:
Cilly Leang 2026-01-23 17:11:13 +11:00
parent a30f557999
commit f3fca134c7
Signed by: cilly
GPG key ID: 6500251E087653C9

View file

@ -1,40 +1,7 @@
This is a Kotlin Multiplatform project targeting Android, Desktop (JVM). # Neon
* [/composeApp](./composeApp/src) is for code that will be shared across your Compose Multiplatform applications. Something new ^-^
It contains several subfolders:
- [commonMain](./composeApp/src/commonMain/kotlin) is for code thats common for all targets.
- Other folders are for Kotlin code that will be compiled for only the platform indicated in the folder name.
For example, if you want to use Apples CoreCrypto for the iOS part of your Kotlin app,
the [iosMain](./composeApp/src/iosMain/kotlin) folder would be the right place for such calls.
Similarly, if you want to edit the Desktop (JVM) specific part, the [jvmMain](./composeApp/src/jvmMain/kotlin)
folder is the appropriate location.
### Build and Run Android Application A Discord client in Compose Multiplatform, mainly targeting Android with
future goals for Desktop. Also serves as a personal playground for trying
To build and run the development version of the Android app, use the run configuration from the run widget out LLM-assisted coding. Here be dragons!
in your IDEs toolbar or build it directly from the terminal:
- on macOS/Linux
```shell
./gradlew :composeApp:assembleDebug
```
- on Windows
```shell
.\gradlew.bat :composeApp:assembleDebug
```
### Build and Run Desktop (JVM) Application
To build and run the development version of the desktop app, use the run configuration from the run widget
in your IDEs toolbar or run it directly from the terminal:
- on macOS/Linux
```shell
./gradlew :composeApp:run
```
- on Windows
```shell
.\gradlew.bat :composeApp:run
```
---
Learn more about [Kotlin Multiplatform](https://www.jetbrains.com/help/kotlin-multiplatform-dev/get-started.html)…