docs: enhance README with project description, architecture, and improved structure

This commit is contained in:
2026-07-08 15:01:19 +02:00
parent 9bf83a32b1
commit d9a3fefbbb
+11 -3
View File
@@ -1,3 +1,10 @@
# Chom Bev e Brezhoneg - Survive in Breton - Survive en Breton
This is a Compose Multiplatform project to listen to Breton from Vannes country. It uses an audio
player adapted for each platform and synchronised subtitles.
## Main architecture
This is a Kotlin Multiplatform project targeting Android, iOS, Web, Desktop (JVM).
* [/iosApp](./iosApp/iosApp) contains an iOS application. Even if youre sharing your UI with
@@ -17,7 +24,7 @@ This is a Kotlin Multiplatform project targeting Android, iOS, Web, Desktop (JVM
the [jvmMain](./shared/src/jvmMain/kotlin)
folder is the appropriate location.
### Running the apps
## Running the apps
Use the run configurations provided by the run widget in your IDE's toolbar. You can also use these
commands and options:
@@ -31,7 +38,7 @@ commands and options:
- JS target (slower, supports older browsers): `./gradlew :webApp:jsBrowserDevelopmentRun`
- iOS app: open the [/iosApp](./iosApp) directory in Xcode and run it from there.
### Running tests
## Running tests
Use the run button in your IDE's editor gutter, or run tests using Gradle tasks:
@@ -80,7 +87,8 @@ To know more about subtitles, see: [SUBTITLES.md](docs/SUBTITLES.md)
## Resources
See [Resource's README.md](data/resources/README.md) to handle the resource files (list of records, audio files,
See [Resource's README.md](data/resources/README.md) to handle the resource files (list of records,
audio files,
and subtitles).
## License