Update README.md
Browse files
README.md
CHANGED
|
@@ -10,21 +10,29 @@ pinned: false
|
|
| 10 |
license: mit
|
| 11 |
---
|
| 12 |
|
| 13 |
-
# π EngGloss β Groq-Powered
|
| 14 |
|
| 15 |
-
|
| 16 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 17 |
|
| 18 |
-
|
| 19 |
|
| 20 |
-
|
| 21 |
|
| 22 |
-
|
| 23 |
-
-
|
| 24 |
-
-
|
| 25 |
-
-
|
| 26 |
|
| 27 |
---
|
| 28 |
|
| 29 |
-
##
|
| 30 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 10 |
license: mit
|
| 11 |
---
|
| 12 |
|
| 13 |
+
# π EngGloss β Groq-Powered Engineering Term Explainer
|
| 14 |
|
| 15 |
+
EngGloss is a small educational web app that explains engineering terms in a short, beginner-friendly structure:
|
| 16 |
+
- π Term
|
| 17 |
+
- π Simple Explanation
|
| 18 |
+
- π§ Real-World Analogy
|
| 19 |
+
- π Typical Formula (if any)
|
| 20 |
+
- ποΈ Practical Engineering Applications
|
| 21 |
|
| 22 |
+
It uses the Groq REST API (no Groq Python SDK) and Gradio for the UI β this avoids known SDK compatibility problems in some environments.
|
| 23 |
|
| 24 |
+
---
|
| 25 |
|
| 26 |
+
## Files
|
| 27 |
+
- `app.py` β Main Gradio application (calls Groq REST API via `requests`)
|
| 28 |
+
- `requirements.txt` β Required Python packages
|
| 29 |
+
- `.env.example` β Example env file for local testing
|
| 30 |
|
| 31 |
---
|
| 32 |
|
| 33 |
+
## Local setup & test
|
| 34 |
|
| 35 |
+
1. Create venv (recommended):
|
| 36 |
+
```bash
|
| 37 |
+
python -m venv venv
|
| 38 |
+
source venv/bin/activate # Windows: venv\Scripts\activate
|