Skip to content

Commit

Permalink
Update README.MD
Browse files Browse the repository at this point in the history
  • Loading branch information
DatL4g authored May 26, 2024
1 parent ed13e82 commit f77da75
Showing 1 changed file with 10 additions and 17 deletions.
27 changes: 10 additions & 17 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,20 +1,13 @@
# Compose Multiplatform Application
# AniFlow

## Before running!
- check your system with [KDoctor](https://github.com/Kotlin/kdoctor)
- install JDK 17 on your machine
- add `local.properties` file to the project root and set a path to Android SDK there
[![Issues](https://img.shields.io/github/issues/DatL4g/AniFlow.svg?style=for-the-badge)](https://github.com/DatL4g/AniFlow/issues)
[![Stars](https://img.shields.io/github/stars/DatL4g/AniFlow.svg?style=for-the-badge)](https://github.com/DatL4g/AniFlow/stargazers)
[![Forks](https://img.shields.io/github/forks/DatL4g/AniFlow.svg?style=for-the-badge)](https://github.com/DatL4g/AniFlow/network/members)
[![Contributors](https://img.shields.io/github/contributors/DatL4g/AniFlow.svg?style=for-the-badge)](https://github.com/DatL4g/AniFlow/graphs/contributors)
[![License](https://img.shields.io/github/license/DatL4g/AniFlow.svg?style=for-the-badge)](https://github.com/DatL4g/AniFlow/blob/master/LICENSE)

### Android
To run the application on android device/emulator:
- open project in Android Studio and run imported android run configuration

To build the application bundle:
- run `./gradlew :composeApp:assembleDebug`
- find `.apk` file in `composeApp/build/outputs/apk/debug/composeApp-debug.apk`

### iOS
To run the application on iPhone device/simulator:
- Open `iosApp/iosApp.xcproject` in Xcode and run standard configuration
- Or use [Kotlin Multiplatform Mobile plugin](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform-mobile) for Android Studio
Welcome to the official repository of "AniFlow"

<a href="https://play.google.com/store/apps/details?id=dev.datlag.aniflow" target="_blank">
<img src="https://play.google.com/intl/en_gb/badges/static/images/badges/en_badge_web_generic.png" width=240 />
</a>

0 comments on commit f77da75

Please sign in to comment.