Update README.md
Browse files
README.md
CHANGED
|
@@ -1,26 +1,18 @@
|
|
| 1 |
-
---
|
| 2 |
-
title: CS & SE Learning Tutor
|
| 3 |
-
emoji: 📈
|
| 4 |
-
colorFrom: gray
|
| 5 |
-
colorTo: blue
|
| 6 |
-
sdk: gradio
|
| 7 |
-
app_file: app.py
|
| 8 |
-
pinned: false
|
| 9 |
-
license: mit
|
| 10 |
-
thumbnail: >-
|
| 11 |
-
https://cdn-uploads.huggingface.co/production/uploads/68668dfd4357f5b535fd7bdc/9rLvqu1gQz9N1JjIgLIpj.png
|
| 12 |
-
sdk_version: 5.43.1
|
| 13 |
-
---
|
| 14 |
# 🎓 AI Learning Tutor For Computer Science Students
|
| 15 |
|
| 16 |
-
|
| 17 |
-
- Pick a **subject** and **topic**
|
| 18 |
-
- Get **step-by-step explanations**
|
| 19 |
-
- Access **extra resources** (YouTube, GitHub, etc.)
|
| 20 |
-
- Follow a **roadmap for mastery**
|
| 21 |
-
- Take a **quiz** and see results
|
| 22 |
|
| 23 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 24 |
```bash
|
| 25 |
pip install -r requirements.txt
|
| 26 |
-
python app.py
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
# 🎓 AI Learning Tutor For Computer Science Students
|
| 2 |
|
| 3 |
+
Lightweight CS/SE tutor. No GPU needed.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
|
| 5 |
+
## Features
|
| 6 |
+
- Step-by-step **Explanation** (Markdown)
|
| 7 |
+
- Curated **Extra Resources**
|
| 8 |
+
- Practical **Roadmap**
|
| 9 |
+
- 5-question **Quiz** with radio options + scoring
|
| 10 |
+
|
| 11 |
+
## Secrets (Settings → Repository secrets)
|
| 12 |
+
- `GROQ_API_KEY` (required)
|
| 13 |
+
- Optional: `GROQ_MODEL` (default: `llama-3.3-70b-versatile`)
|
| 14 |
+
|
| 15 |
+
## Run locally
|
| 16 |
```bash
|
| 17 |
pip install -r requirements.txt
|
| 18 |
+
python app.py
|