From f3fca134c707f54ebed4a58f7516c35ac5999d3d Mon Sep 17 00:00:00 2001 From: Cilly Leang Date: Fri, 23 Jan 2026 17:11:13 +1100 Subject: [PATCH] chore(readme): update --- README.md | 43 +++++-------------------------------------- 1 file changed, 5 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 98d7e7e..195f930 100644 --- a/README.md +++ b/README.md @@ -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. - It contains several subfolders: - - [commonMain](./composeApp/src/commonMain/kotlin) is for code that’s 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 Apple’s 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. +Something new ^-^ -### Build and Run Android Application - -To build and run the development version of the Android app, use the run configuration from the run widget -in your IDE’s 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 IDE’s 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)… \ No newline at end of file +A Discord client in Compose Multiplatform, mainly targeting Android with +future goals for Desktop. Also serves as a personal playground for trying +out LLM-assisted coding. Here be dragons!