diff --git a/solutions/_Плоская_карточка/README.md b/solutions/_Плоская_карточка/README.md new file mode 100644 index 0000000..7d5950f --- /dev/null +++ b/solutions/_Плоская_карточка/README.md @@ -0,0 +1,85 @@ +# Плоская карточка + +**Плоская карточка** – это небольшое приложение на Python, которое преобразует сырой текст задания в формат «плоской карточки» (с заголовком, списками и примерами). +В проекте реализован один скрипт `main.py`, который читает входной файл с заданием, обрабатывает его и выводит результат в консоль или сохраняет в новый файл. + +--- + +## 📦 Установка зависимостей + +```bash +# Создайте виртуальное окружение (рекомендуется) +python -m venv .venv +source .venv/bin/activate # Windows: .venv\Scripts\activate + +# Установите зависимости из requirements.txt +pip install -r requirements.txt +``` + +> **Важно** +> В `requirements.txt` указаны только стандартные библиотеки, но если вы захотите добавить сторонние пакеты (например, `rich` для красивого вывода), просто добавьте их туда и выполните `pip install -r requirements.txt`. + +--- + +## 🚀 Запуск + +### 1. Пример входного файла (`task.txt`) +```text +Задача: Написать функцию, которая возвращает сумму двух чисел. +Параметры: +- a (int): первое число +- b (int): второе число +Пример использования: +>>> sum_two(3, 5) +8 +``` + +### 2. Запуск скрипта + +```bash +# Вариант 1 – вывод в консоль +python main.py task.txt + +# Вариант 2 – сохранить результат в файл +python main.py task.txt --output result.md +``` + +> Скрипт автоматически определит формат входного файла (txt, md и т.д.) и преобразует его в «плоскую карточку» с заголовком, списками и блоком кода. + +--- + +## 📄 Пример вывода + +```markdown +# Задача: Написать функцию, которая возвращает сумму двух чисел. + +**Параметры:** +- `a` (int): первое число +- `b` (int): второе число + +**Пример использования:** + +```python +>>> sum_two(3, 5) +8 +``` +``` + +--- + +## 🛠️ Как это работает + +1. **Чтение файла** – скрипт открывает указанный файл и читает его содержимое. +2. **Парсинг текста** – с помощью простых регулярных выражений выделяются заголовок, параметры и пример кода. +3. **Форматирование** – полученные данные форматируются в Markdown‑карточку. +4. **Вывод/Сохранение** – результат выводится в консоль или записывается в файл. + +--- + +## 📚 Дальнейшее развитие + +- Добавить поддержку более сложных форматов (JSON, YAML). +- Встроить автогенерацию тестов из примеров кода. +- Интеграция с GitHub Actions для автоматической генерации карточек при коммите. + +--- \ No newline at end of file