papyrus/PhonoCoach
1
0
Fork 0
mirror of https://github.com/Manoj-HV30/PhonoCoach.git synced 2026-05-16 19:35:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix formatting and headings in README.md

Browse Source
This commit is contained in:
Wander_lust
2026-01-21 16:12:54 +05:30
committed by GitHub
parent 8751487f22
commit 2677715eec
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+5 -5
View File
@@ -6,7 +6,7 @@ Chrome extension with FastAPI backend for real-time pronunciation feedback using
## 2️⃣ Getting Started ## 2️⃣ Getting Started
### 🛠️ Prerequisites ### Prerequisites
- **Python 3.12+** - **Python 3.12+**
- **pip** - **pip**
@@ -33,7 +33,7 @@ pip install -r requirements.txt
# e)Start the FastAPI backend server # e)Start the FastAPI backend server
uvicorn backend.server:app --reload uvicorn backend.server:app --reload
``` ```
### 🖥️ Load the Chrome Extension Locally ### Load the Chrome Extension Locally
1. Open Chrome and go to `chrome://extensions/` 1. Open Chrome and go to `chrome://extensions/`
2. Enable **Developer mode** (toggle in the top-right) 🛠️ 2. Enable **Developer mode** (toggle in the top-right) 🛠️
@@ -50,7 +50,7 @@ uvicorn backend.server:app --reload
3. Click **🎙 Record** to start recording your voice. 3. Click **🎙 Record** to start recording your voice.
4. Click **Stop** to upload audio and analyze pronunciation. 4. Click **Stop** to upload audio and analyze pronunciation.
5. View similarity score, phoneme-level feedback, and improvement tips. 5. View similarity score, phoneme-level feedback, and improvement tips.
## 4️⃣ Features ✨ ## 4️⃣ Features
- Real-time pronunciation analysis for any selected text on any webpage - Real-time pronunciation analysis for any selected text on any webpage
- Phoneme-level feedback highlighting correct, incorrect, missing, and extra sounds - Phoneme-level feedback highlighting correct, incorrect, missing, and extra sounds
@@ -64,8 +64,8 @@ uvicorn backend.server:app --reload
## 5️⃣ Dev Notes ## 5️⃣ Dev Notes
- Make sure the backend server is running before using the Chrome extension. - Make sure the backend server is running before using the Chrome extension.
- Ensure `ffmpeg` is installed and accessible in your system PATH. ⚡ - Ensure `ffmpeg` is installed and accessible in your system PATH.
- ⚠️ The Chrome extension is loaded locally and is ***NOT YET PUBLISHED*** on the Web Store. - The Chrome extension is loaded locally and is ***NOT YET PUBLISHED*** on the Web Store.
- In `backend/server.py`, the Whisper model `"small"` is loaded by default. Users can change it to other models based on their system’s processing power: - In `backend/server.py`, the Whisper model `"small"` is loaded by default. Users can change it to other models based on their system’s processing power:
| Model | Approx. RAM Required | Recommended Use Case | | Model | Approx. RAM Required | Recommended Use Case |