Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gunarakulangunaretnam committed Jan 19, 2024
1 parent 9d30b90 commit 6606ccf
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 19 deletions.
50 changes: 36 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,55 @@

## 01 Introduction

A voice recognition based tool for translating languages in real time. This tool could be used to translate languages with voice data. For an example, it can listen and, translate that voice data into the target language then, it speaks out as a voice output, similar to a human translator, who listens and then translate in a targeted language.

This is not efficient like human translator, it is using the google translate platform as backbone to perform the translation process.
A voice recognition-based tool for translating languages in real-time. This tool serves as a virtual interpreter, offering users a convenient and efficient way to bridge language gaps. Inspired by the natural process of human translation, the tool listens to spoken words and converts them into the target language, replicating the fluidity and accuracy of a human translator.

![Banner Image](docs/media/0-banner-image.png)


![diagram](docs/media/system-architeture.png)

## 02 Technology Stack

- Python 3.8
- Python (v3.8.5 Recommended)
- GTTS Module
- SpeechRecognition Module
- Playsound Module
- Googletrans Module
- Streamlit UI Module
- Pygame Module
- Googletrans (v3.1.0a0 Recommended)

## 03 System Architeture Diagram

![diagram](docs/media/1-system-architeture.png)

## 04 Setup

- **Step 01:** Navigate to the following directory.

```
language-translator-bot/docs/requirements.txt
```

- **Step 02:** Run this command to install all dependencies.

```
pip install -r requirements.txt
```



## 05 Usage

- **Step 02:** Navigate to the source directory.

```
language-translator-bot/soruce/main.py
```

## 03 Setup

- **Step 02:** Run this command to launch the app.

## 04 Usage
```
streamlit run main.py
```

```
python main.py

```

## Social Links

Expand Down
Binary file added docs/media/2-demo-video.webm
Binary file not shown.
8 changes: 5 additions & 3 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
playsound
SpeechRecognition
googletrans
gtts
pygame
streamlit
speechrecognition
googletrans==3.1.0a0
4 changes: 2 additions & 2 deletions soruce/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ def main_process(output_placeholder, from_language, to_language):
st.title("Language Translator")

# Dropdowns for selecting languages
from_language_name = st.selectbox("From", list(LANGUAGES.values()))
to_language_name = st.selectbox("To", list(LANGUAGES.values()))
from_language_name = st.selectbox("Select Source Language:", list(LANGUAGES.values()))
to_language_name = st.selectbox("Select Target Language:", list(LANGUAGES.values()))

# Convert language names to language codes
from_language = get_language_code(from_language_name)
Expand Down

0 comments on commit 6606ccf

Please sign in to comment.