Skip to content

Commit 2fc3699

Browse files
committed
docs: update README with complete documentation
1 parent 65453ac commit 2fc3699

File tree

1 file changed

+98
-2
lines changed

1 file changed

+98
-2
lines changed

README.md

Lines changed: 98 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,99 @@
1-
# flutter_text_recognition
1+
<div align="center">
2+
<h1>Flutter Text Recognition</h4>
3+
<h3>UAS Mata Kuliah Pengolahan Citra</h3>
4+
</div>
25

3-
A new Flutter project.
6+
## 🚀 Getting Started
7+
8+
Follow these instructions to set up and run the project locally.
9+
10+
## ⚙️ Prerequisites
11+
12+
Make sure you have the following installed on your system:
13+
```
14+
Flutter SDK (3.35.3 or higher)
15+
Git
16+
Android Studio (For Android Development)
17+
Xcode (For ios development)
18+
```
19+
20+
## 📥 Installation
21+
22+
1. Clone the repository:
23+
24+
```
25+
git clone https://github.com/bert093/Flutter-Text-Recognition.git
26+
```
27+
28+
2. Navigate to project directory:
29+
30+
```
31+
cd flutter-text-recognition
32+
```
33+
34+
3. Install dependencies:
35+
36+
```
37+
flutter pub get
38+
```
39+
40+
4. Run the application:
41+
42+
```
43+
flutter run
44+
```
45+
46+
## 🛠️ Technologies Used
47+
48+
This project is built using:
49+
50+
### Framework & Language
51+
- [x] Flutter - Cross platform framework
52+
- [x] Dart - Programming language
53+
54+
### Packages & Dependencies
55+
- [x] Google ML Kit (packages) - Text Recognition API
56+
- [x] Camera (packages) - Real-time camera access
57+
- [x] Image Picker (packages) - Gallery image selection
58+
- [x] Permission Handler (packages) - Runtime permission
59+
60+
## 📁 Project Structure
61+
62+
```
63+
Portofolio Website
64+
├─ desktop.ini
65+
├─ img
66+
│ └─ saya1.png
67+
├─ index.html
68+
├─ README.md
69+
├─ script.js
70+
└─ style.css
71+
72+
```
73+
74+
## ✨ Features
75+
76+
- Real-time text detection from camera
77+
- Image text recognition from gallery
78+
- Terminal logging for debugging
79+
- Camera & Storage permission handling
80+
81+
```
82+
flutter_text_recognition
83+
├─ android/
84+
├─ ios/
85+
├─ lib/
86+
│ ├─ camera/
87+
│ │ └─ camera_new.dart
88+
│ └─ main.dart
89+
├─ linux/
90+
├─ macos/
91+
├─ web/
92+
└─ windows/
93+
├─ .gitignore
94+
├─ analysis_options.yaml
95+
├─ .metadata
96+
├─ pubspec.lock
97+
├─ pubspec.yaml
98+
├─ README.md
99+
```

0 commit comments

Comments
 (0)