Skip to content

Commit 8c5929d

Browse files
Yugesh-Kumar-Smariobehlingsourcery-ai[bot]
authored
Update readme (#5)
* Update README.md * Update README.md * Update README.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> --------- Co-authored-by: Mario Behling <[email protected]> Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
1 parent e4aa8fe commit 8c5929d

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,17 @@
22

33
A new Flutter project.
44

5+
## Table of Contents
6+
- [Getting Started](#getting-started)
7+
- [Assets](#assets)
8+
- [Localization](#localization)
9+
- [Installation Steps](#installation-steps)
10+
- [Prerequisites](#prerequisites)
11+
- [Clone the Repository](#clone-the-repository)
12+
- [Install Dependencies](#install-dependencies)
13+
- [Running the Project](#running-the-project)
14+
15+
516
## Getting Started
617

718
This project is a starting point for a Flutter application that follows the
@@ -27,3 +38,47 @@ the `lib/src/localization` directory.
2738

2839
To support additional languages, please visit the tutorial on
2940
[Internationalizing Flutter apps](https://flutter.dev/to/internationalization).
41+
42+
## Installation Steps
43+
44+
### Prerequisites
45+
46+
##### Before setting up the project, ensure you have the following installed:
47+
48+
Flutter SDK: Install from Flutter's official website.
49+
50+
Dart SDK: Included with Flutter, but verify installation using `dart --version`
51+
52+
Git: Required for cloning the repository. Install from Git's official site.
53+
54+
Android Studio or VS Code: Recommended IDEs for Flutter development.
55+
56+
Android Emulator or Physical Device: For running the application.
57+
58+
59+
1. Clone the Repository
60+
```
61+
git clone https://github.com/fossasia/magic-epaper-app
62+
cd magic-epaper-app
63+
```
64+
65+
2. Install Dependencies
66+
```
67+
flutter pub get
68+
```
69+
70+
## Running the Project
71+
72+
1. Run on an Emulator or Physical Device
73+
74+
Ensure an emulator is running or a device is connected.
75+
76+
Execute:
77+
```
78+
flutter run
79+
```
80+
2. Build the App (For production/testing)
81+
```
82+
flutter build apk # For Android
83+
flutter build ios # For iOS (macOS required)
84+
```

0 commit comments

Comments
 (0)