ai-fluency: README.md

2026-05-28 10:16:30 +00:00
parent 7ef08e842a
commit f24f550556
1 changed files with 88 additions and 2 deletions
@@ -1,3 +1,89 @@
-# task-69970ff6-ai-fluency
+# AI Fluency – Personal Learning Plan Generator

-Решения домашних заданий
+**AI‑Fluency** is a lightweight Python utility that builds a personalized learning plan for anyone looking to improve their skills in artificial intelligence and related fields.  
+Given a user profile (name, experience level, interests) the script produces a step‑by‑step roadmap with suggested resources, projects, and milestones.
+
+> **Why this project?**  
+> Many people struggle to structure their AI education. This tool removes guesswork by automatically generating a curriculum tailored to your current level and passions.
+
+---
+
+## 📦 Installation
+
+The project depends on the following Python packages:
+
+| Package | Purpose |
+|---------|---------|
+| `rich`  | Pretty console output (tables, colors) |
+
+```bash
+# Clone the repo
+git clone https://github.com/your-username/ai-fluency.git
+cd ai-fluency
+
+# Create a virtual environment (recommended)
+python -m venv .venv
+source .venv/bin/activate   # Windows: .\.venv\Scripts\activate
+
+# Install dependencies
+pip install rich
+```
+
+> **Tip:** If you prefer `pipx` or Docker, feel free to adapt the instructions accordingly.
+
+---
+
+## 📄 Usage
+
+1. **Create a user profile** – a JSON file that describes your background and interests.
+
+   ```json
+   {
+     "name": "Иван",
+     "experience_level": "beginner",          // beginner | intermediate | advanced
+     "interests": ["machine learning", "NLP"]
+   }
+   ```
+
+2. **Run the script** – it will load the profile, generate a plan, and display it in a nicely formatted table.
+
+   ```bash
+   python solution.py path/to/profile.json
+   ```
+
+3. **Result**
+
+   ```
+   ✅ Профиль пользователя загружен: Иван
+
+   ┏━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+   │ Этап          │ Описание                       │
+   ┠────────────────╪───────────────────────────────┨
+   │ 1. Основы Python│ Изучить синтаксис, типы данных│
+   │ 2. ML Intro     │ Курс по машинному обучению    │
+   │ …               │ …                              │
+   ┗━━━━━━━━━━━━━━━┻━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
+   ```
+
+> The table will contain as many stages as the generator decides based on your level and interests.
+
+---
+
+## 🔧 Extending the Generator
+
+The core logic lives in `solution.py`.  
+Feel free to:
+
+- Add more experience levels.
+- Expand the mapping of interests → resources.
+- Hook up a real database or API for dynamic content.
+
+Just modify the `generate_plan` function – it returns a list of dictionaries that are rendered by `rich`.
+
+---
+
+## 📄 License
+
+MIT © 2026 AI‑Fluency Project
+
+---