From e407e03e9067a910b23c3b7ec80c837eff55315a Mon Sep 17 00:00:00 2001 From: nrobi144 Date: Sun, 28 Dec 2025 07:21:36 +0200 Subject: [PATCH] update readme --- README.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 46f7773a0..7a620308b 100644 --- a/README.md +++ b/README.md @@ -153,9 +153,11 @@ Information shared on Nostr can be re-broadcasted to other servers and should be # Development Overview -This repository is split between Amethyst and Quartz: -- Amethyst is a native Android app made with Kotlin and Jetpack Compose. -- Quartz is our own Nostr-commons library to host classes that are of interest to other Nostr Clients. +This repository is split between Amethyst, Quartz, Commons, and DesktopApp: +- **Amethyst** - Native Android app with Kotlin and Jetpack Compose +- **Quartz** - Nostr-commons KMP library for protocol classes shared across platforms +- **Commons** - Kotlin Multiplatform module with shared UI components (icons, robohash, blurhash, composables) +- **DesktopApp** - Compose Multiplatform Desktop application reusing commons and quartz The app architecture consists of the UI, which uses the usual State/ViewModel/Composition, the service layer that connects with Nostr relays, and the model/repository layer, which keeps all Nostr objects in memory, in a full OO graph. @@ -187,11 +189,17 @@ git clone https://github.com/vitorpamplona/amethyst.git Use an Android Studio build action to install and run the app on your device or a simulator. ## Building -Build the app: + +Build the Android app: ```bash ./gradlew assembleDebug ``` +Build and run the Desktop app (requires Java 21+): +```bash +./gradlew :desktopApp:run +``` + ## Testing ```bash ./gradlew test