Skip to content

Commit 771b180

Browse files
added images to readme
1 parent 06149cf commit 771b180

File tree

3 files changed

+10
-8
lines changed

3 files changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,16 @@ The app consists of one page with the following components:
7171
- button that opens a pop-up with the usage instructions for the app
7272
- a text component, where the translation will be displayed
7373

74+
<img src="readme_images/ss1.jpg" height="450">
75+
<img src="readme_images/ss2.jpg" height="450">
76+
77+
### Translation Workflow
78+
1. Open the app.
79+
2. Tap **Start Translation** to begin.
80+
3. The app captures images periodically and sends them to the backend for processing.
81+
4. Tap **Stop Translation** to end the process.
82+
5. View the translation result displayed on the screen.
83+
7484
## Backend
7585
- the `backend/` directory
7686
A Flask server for processing and classifying images. The server allows users to upload images from the frontend of the app, after which the server processes them using an AI model.
@@ -87,11 +97,3 @@ The server includes the following routes:
8797
- Iterates through all the files saved in the folder using a classification list, leveraging a function from the AI model to classify each image. The highest-probability prediction (usually the first result) is appended to the list.
8898
- The results are concatenated and formatted into a string, which is then passed to the `call_openai_model` function from the AI module to generate a translation.
8999
- Returns the content of the translation in JSON format.
90-
91-
### Translation Workflow
92-
1. Open the app.
93-
2. Tap **Start Translation** to begin.
94-
3. The app captures images periodically and sends them to the backend for processing.
95-
4. Tap **Stop Translation** to end the process.
96-
5. View the translation result displayed on the screen.
97-

readme_images/ss1.jpg

97.9 KB
Loading

readme_images/ss2.jpg

104 KB
Loading

0 commit comments

Comments
 (0)