diff --git a/README.md b/README.md index 8ef5c9b4..bc845d29 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # Mangayomi -Mangayomi is free and open source manga reader inspired by Tachiyomi made with flutter. It allows users to read manga from multiple platforms and is developed out of passion and the challenge of creating such an application. Currently, all content sources are directly integrated into the application. +Mangayomi is free and open source manga reader inspired by Tachiyomi made with flutter. It allows users to read manga from multiple sources and is developed out of passion and the challenge of creating such an application. Currently, all content sources are directly integrated into the application. + +### Prerequisites + +You can install Flutter & Dart from [Official website](https://docs.flutter.dev/get-started/install) + + - Dart sdk + - Flutter - Channel Stable + +### Building + +1. Clone the repository: + +``` + $ git clone https://github.com/kodjodevf/mangayomi.git + $ cd mangayomi/ +``` +2. You can install all dependencies by running this command in terminal: + +``` + $ flutter pub get +``` + +3. Now enter the following command to start debugging the app: + +``` + $ flutter run +```