# MD to Files Parser - Краткая Инструкция на Русском

**Версия:** 1.0  
**Дата:** 2025-10-30  
**Совместимость:** MD to Files v6.0.1+  
**Автор:** Mikhail Deynekin  

---

## ⚡ За 30 Секунд

**Что это:** Стандартный формат для ответов LLM, который позволяет автоматически создавать проекты  
**Зачем:** Чтобы за секунды создать готовый проект вместо ручного копирования кода  
**Как:** Добавить в запрос специальный промт  
**Результат:** `./MD_to_Files.sh response.md ./output` → готовый проект!

---

## 🎯 Три Обязательных Элемента

### 1. Дерево Проекта (в коде)

```text
project/
├── src/
│   └── main.py
└── requirements.txt
```

**Правила:**
- Начинается с `project/`
- Используются символы `├──`, `│`, `└──`
- Папки заканчиваются на `/`
- Завёрнуто в ``` ```text ```

> **v6.0.1 и новее:** дерево нужно читателю, а папки создаются из путей в маркерах
> файлов. Пустая папка из дерева не создаётся, и ответ без маркеров не даст файлов.

### 2. Маркеры Файлов (первая строка в коде)

```python
# [file name]: src/main.py
```

**Правила:**
- Точный формат: `[file name]: путь/до/файла.расширение`
- Первая строка после открытия кода
- Работает с любым комментарием: `#`, `//`, `--`, `REM`

### 3. Блоки Кода (с языком)

```python
# [file name]: src/main.py
def hello():
    print("Hello World")
```

**Правила:**
- Язык обязателен: `python`, `js`, `ts` и т.д.
- Полный рабочий код
- Все импорты включены

---

## 📋 Чеклист перед Отправкой

```
□ Дерево начинается с "project/"
□ Используются ├──, │, └── символы
□ Дерево в коде блоке с ```
□ Маркер файла: [file name]: путь
□ Маркер в первой строке после забора
□ Код блок имеет идентификатор языка
□ Все файлы дерева имеют код
□ Код полный и рабочий
□ Есть README.md
□ Перечислены зависимости
```

---

## 🔴 Типичные Ошибки

| ❌ Неправильно | ✅ Правильно |
|---------------|------------|
| Нет дерева | Дерево с project/ корнем |
| Маркер после импортов | Маркер в строке 1 |
| Абсолютные пути | Относительные пути |
| Обратные слэши `\` | Прямые слэши `/` |
| Без идентификатора языка | ```python, ```js |
| Неполный код | Полный рабочий код |
| Без маркеров | Каждый файл помечен |

---

## 💬 Готовый Промт (Копировать и Вставить)

**Добавьте в конец ЛЮБОГО запроса на создание кода:**

```
Отформатируйте ответ для MD to Files Parser (v6.0.1+):
- Полное дерево проекта в начале с корнем project/
- Каждый файл помечен: [file name]: путь на первой строке
- Идентификаторы языков (python, js и т.д.)
- Все конфигурационные файлы и зависимости
- Инструкции по настройке в README
```

---

## 🛠️ Одна Команда для Запуска

```bash
# Проверить формат (без создания):
./MD_to_Files.sh -d response.md /tmp/test

# Создать проект:
./MD_to_Files.sh -v response.md ./мой_проект

# С резервной копией:
./MD_to_Files.sh -vb response.md ./мой_проект

# С метаданными проекта:
./MD_to_Files.sh -vbP response.md ./мой_проект
```

---

## 📁 Примеры Маркеров Файлов

```python
# [file name]: src/main.py
```

```javascript
// [file name]: src/index.js
```

```bash
# [file name]: scripts/setup.sh
```

```json
// [file name]: config.json
```

---

## ✅ Почему Это Нужно

| Преимущество | Результат |
|-------------|-----------|
| **Автоматизация** | Вручную → Секунды |
| **Точность** | Человеческие ошибки → Ноль |
| **Повторяемость** | Один раз → Повторяемо |
| **Масштабируемость** | 5 файлов → 100+ файлов |
| **CI/CD готовность** | Ручное → Автоматизированное |

---

## 🔗 Правила для Путей Файлов

```
✅ ПРАВИЛЬНЫЕ:
[file name]: src/main.py
[file name]: config/settings.json
[file name]: tests/unit/test_auth.py
[file name]: .gitignore

❌ НЕПРАВИЛЬНЫЕ:
[file name]: /usr/bin/script.sh          (абсолютный путь)
[file name]: ../../../../etc/passwd       (обход папок)
[file name]: ../../../main.py             (с родительской папкой)
```

---

## 🎨 Формат Дерева

```
✅ ПРАВИЛЬНЫЕ СИМВОЛЫ:
├── (ветка: ├ + 2 дефиса)
│   (труба: вертикальная линия, пробел)
└── (последняя: └ + 2 дефиса)

✅ ПРАВИЛЬНАЯ СТРУКТУРА:
project/
├── directory/
│   └── file.txt
└── file2.txt

❌ НЕПРАВИЛЬНЫЕ СИМВОЛЫ:
|-- (должно быть ├--)
|   (должно быть │)
\-- (должно быть └--)
```

---

## 📊 Размеры Проектов

| Размер | Глубина | Файлы | Время |
|--------|---------|-------|-------|
| Маленький | 2-3 | 5-10 | <5 сек |
| Средний | 3-4 | 15-30 | 5-10 сек |
| Большой | 4-5 | 50+ | 10-30 сек |

---

## 🆘 Быстрая Помощь

**Проблема:** "No project structures found"  
**Решение:** Убедитесь, что дерево начинается с `project/` в блоке кода

**Проблема:** "File name too long"  
**Решение:** Маркер должен быть чистым `[file name]: путь` без лишнего текста

**Проблема:** Файлы созданы, но пусты  
**Решение:** Маркер должен быть на строке 1 после забора, не после импортов

**Проблема:** Ошибки с --help  
**Решение:** Обновитесь до v6.0.1+

---

## 🔄 Полный Рабочий Процесс

```
1. Напишите Запрос
   ↓
2. Добавьте Промт (выше)
   ↓
3. Получите Ответ от LLM
   ↓
4. Проверьте: ./MD_to_Files.sh -d response.md /tmp/check
   ↓
5. Создайте: ./MD_to_Files.sh response.md ./output
   ↓
6. Готово! → Проект создан
```

---

## 📄 Минимальный Промт

**Просто скопируйте и вставьте:**

```
Отформатируйте ответ для MD to Files Parser:
1. Полное дерево проекта в коде
2. Каждый файл помечен: [file name]: путь на первой строке
3. Все зависимости и инструкции по настройке
```

---

## 💾 Пример Структуры

```
ЗАПРОС:
"Создайте Python Flask API"

+ ПРОМТ:
"Отформатируйте для MD to Files Parser v6.0.1+: [выше]"

= ОТВЕТ:
```text
project/
├── app.py
├── requirements.txt
└── README.md
```

```python
# [file name]: app.py
from flask import Flask
app = Flask(__name__)

@app.route('/')
def hello():
    return 'Hello'

if __name__ == '__main__':
    app.run()
```

```
requirements.txt
# [file name]: requirements.txt
Flask==2.0.0
```

```markdown
# [file name]: README.md
# Flask API

## Установка
pip install -r requirements.txt
```

РЕЗУЛЬТАТ:
✓ Создано: project/app.py
✓ Создано: project/requirements.txt
✓ Создано: project/README.md
```

---

## 🎨 Таблица Идентификаторов Языков

| Язык | Идентификатор |
|------|---------------|
| Python | `python` или `py` |
| JavaScript | `javascript` или `js` |
| TypeScript | `typescript` или `ts` |
| Bash/Shell | `bash` или `sh` |
| JSON | `json` |
| YAML | `yaml` или `yml` |
| PHP | `php` |
| SQL | `sql` |
| HTML | `html` |
| CSS | `css` |
| Java | `java` |
| C++ | `cpp` или `c++` |
| Go | `go` |
| Rust | `rust` |
| Текст/Дерево | `text` или `markdown` |

---

## 🔐 Правила Безопасности

**Всегда проверяйте пути:**
- ✅ `src/main.py` - безопасно
- ❌ `/etc/passwd` - опасно
- ❌ `../../secrets.txt` - опасно
- ❌ `$(rm -rf /)` - попытка взлома

---

## 📞 Быстрая Помощь

**Формат валиден?**
```bash
grep "project/" response.md           # проверить дерево
grep "\[file name\]:" response.md     # проверить маркеры
```

**Создать проект:**
```bash
./MD_to_Files.sh response.md ./output
```

**Больше опций:**
```bash
./MD_to_Files.sh --help
```

---

## 📚 Документация

- **Полное руководство** (английский): PROMPT_GUIDE.md
- **Примеры** (английский): EXAMPLES.md
- **Быстрая справка**: QUICK_REFERENCE.md
- **Индекс**: INDEX.md

---

## ⚡ Советы Профи

1. **Сохраните промт**:
```bash
alias md2-short='echo "Отформатируйте для MD to Files Parser..."'
```

2. **Чейн команд**:
```bash
curl api.example.com | ./MD_to_Files.sh - ./output
```

3. **Пакетная обработка**:
```bash
for file in responses/*.md; do
  ./MD_to_Files.sh "$file" "output/$(basename $file .md)"
done
```

---

## 📝 Пример Полного Запроса

```
Создайте Python приложение для конвертации температуры с исправлениями.

Требования:
- Функции конвертации Цельсия↔Фаренгейт
- Интерактивный CLI интерфейс
- Обработка ошибок

Отформатируйте ответ для MD to Files Parser (v6.0.1+):
- Полное дерево проекта в начале с project/ корнем
- Каждый файл помечен: [file name]: путь на первой строке
- Идентификаторы языков (python, js и т.д.)
- Все конфигурационные файлы и зависимости
- Инструкции по установке и запуску
```

---

## 🎯 Итого

1. ✅ Добавьте готовый промт к вашему запросу
2. ✅ Получите структурированный ответ
3. ✅ Запустите одну команду
4. ✅ Проект создан!

**Сэкономленное время:** ~90 минут на каждый проект

---

## 📞 Контакты

- **Автор:** Mikhail Deynekin
- **Email:** mid1977@gmail.com
- **Сайт:** https://deynekin.com
- **Лицензия:** PolyForm Noncommercial 1.0.0

---

*Последнее обновление: 2025-10-30*  
*Совместимость: MD to Files v6.0.1+*  
*Язык: Русский (RU)*

