MoadMerroun commited on
Commit
720e6b5
·
verified ·
1 Parent(s): 9e030a5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +25 -4
README.md CHANGED
@@ -11,9 +11,30 @@ pinned: false
11
  short_description: Streamlit template space
12
  ---
13
 
14
- # Welcome to Streamlit!
 
15
 
16
- Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
 
 
17
 
18
- If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
19
- forums](https://discuss.streamlit.io).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
11
  short_description: Streamlit template space
12
  ---
13
 
14
+ ## 🚀 How to Use
15
+ 👉 [Click here to open the app](https://huggingface.co/spaces/MoadMerroun/english-accent-detection)
16
 
17
+ 1. Paste a public video URL (e.g., Google Drive MP4 link)
18
+ 2. Click "Analyze"
19
+ 3. See results: accent + confidence score
20
 
21
+ > ⚠️ Only works with publicly accessible video links (not password-protected).
22
+
23
+
24
+ ## ⚙️ Local Setup
25
+
26
+ ```bash
27
+ # Clone repo
28
+ git clone https://huggingface.co/spaces/MoadMerroun/english-accent-detection
29
+ cd accent-detector
30
+
31
+ # Create virtual environment
32
+ python -m venv venv
33
+ source venv/bin/activate # or venv\Scripts\activate on Windows
34
+
35
+ # Install dependencies
36
+ pip install -r requirements.txt
37
+
38
+ # Run Streamlit app
39
+ streamlit run .\src\streamlit_app.py
40
+ ```