ai‑fluency: README.md

2026-05-26 16:11:01 +00:00
parent e2b96cf446
commit 13ff205035
1 changed files with 113 additions and 0 deletions
@@ -0,0 +1,113 @@
+# ai‑fluency
+
+**ai‑fluency** – это проект, созданный в рамках курса *Ai Fluency*.  
+В нём реализован персональный план развития навыков работы с ИИ, построенный по заданию **Build a personal AI fluency plan**.  
+
+---
+
+## 📌 Описание
+
+- Проект содержит готовый план развития, разбитый на этапы, темы и практические задания.
+- В качестве примера план представлен в виде Markdown‑файла `plan.md`, а также в виде Python‑скрипта `generate_plan.py`, который генерирует план в формате JSON.
+- В проекте есть небольшая CLI‑утилита `cli.py`, позволяющая просматривать план, экспортировать его в различные форматы и получать подсказки по каждому этапу.
+
+---
+
+## ⚙️ Установка зависимостей
+
+```bash
+# Создайте виртуальное окружение (рекомендуется)
+python -m venv .venv
+source .venv/bin/activate   # Windows: .venv\Scripts\activate
+
+# Установите зависимости
+pip install -r requirements.txt
+```
+
+`requirements.txt` содержит:
+
+```
+click==8.1.7
+rich==13.7.0
+```
+
+---
+
+## 🚀 Запуск
+
+### 1. Генерация плана (Python‑скрипт)
+
+```bash
+python generate_plan.py
+```
+
+После выполнения в корне проекта появится файл `plan.json` с полным описанием плана.
+
+### 2. CLI‑утилита
+
+```bash
+python cli.py
+```
+
+CLI предоставляет следующие команды:
+
+| Команда | Описание |
+|---------|----------|
+| `show` | Показать план в читаемом виде |
+| `export --format json` | Экспортировать план в JSON |
+| `export --format md` | Экспортировать план в Markdown |
+| `hint <этап>` | Получить подсказку по конкретному этапу |
+
+Пример:
+
+```bash
+python cli.py show
+python cli.py export --format md
+python cli.py hint 3
+```
+
+### 3. Просмотр готового Markdown‑плана
+
+```bash
+cat plan.md
+```
+
+---
+
+## 📄 Пример использования
+
+```bash
+# 1. Генерируем план
+python generate_plan.py
+
+# 2. Просматриваем план
+python cli.py show
+
+# 3. Экспортируем в Markdown
+python cli.py export --format md
+
+# 4. Получаем подсказку по этапу 5
+python cli.py hint 5
+```
+
+После выполнения вы получите:
+
+- `plan.json` – структурированный JSON‑план
+- `plan.md` – читаемый Markdown‑план
+- В консоли – подробный вывод по каждому этапу и подсказки
+
+---
+
+## 📚 Что дальше?
+
+- Добавьте собственные практические задания в `plan.md`.
+- Расширьте CLI, добавив поддержку экспорта в PDF или HTML.
+- Интегрируйте план с системой трекера задач (например, Trello, Notion).
+
+---
+
+## 📞 Поддержка
+
+Если возникли вопросы – создайте issue в репозитории или напишите в Discord‑канал курса.
+
+---