md_to_gost/AI-Docs_WriteHuman/docs/quickstart.md

Быстрый старт

Установка

Нужен Python 3.10+.

uv sync          # окружение по uv.lock (канонический lock-файл)
# или
pip install -e .

Для продолжения таблиц/листингов через Word COM (режим word по умолчанию) на Windows:

pip install pywin32

Нужны установленный Microsoft Word.

Запуск

python -m md2gost              # GUI без файла
python -m md2gost --gui
python -m md2gost report.md -o report.docx --type coursework --check
md2gost-gui                    # то же GUI (entry point)

Windows exe

В корне репозитория: build-exe.bat → dist\md2gost.exe.

• Двойной клик — GUI.
• CLI: md2gost.exe report.md -o report.docx --type coursework.

GUI за минуту

1. Перетащите .md в верхнюю область (или кликните по ней).
2. Выберите тип документа (practice по умолчанию).
3. При необходимости: Настройки → Файлы (титул, задание), Настройки → Студент… (ФИО и группа для автотитула), Настройки → Метаданные… (свойства DOCX), Настройки → Диаграммы, меню «Шаблоны UML».
4. Нажмите «Конвертировать».

Справка в меню: Инструкция, Схемы, Промпт для ИИ.

Автотитул (info_conv.yaml + блок title): title.md.

Типы документов (кратко)

--type	Назначение
practice / coursework	Практика / курсовая по ТЗ МИРЭА
vkr	ВКР (раздельный список, графическое приложение)
PIS_custom	Итоговый отчёт по практическим работам
APID_coursework	Курсовая «Архитектура приложений и данных»

Подробнее: types.md.

Следующие шаги

• Написать отчёт в диалекте md2gost: markdown.md
• Автотитульник: title.md
• Вставить диаграммы: schemes.md
• Сгенерировать .md через ИИ: prompts.md