Igor20264
818a044aa1
Python application / build (push) Has been cancelled
- update документация - промт для ии полу конфигурируемый
62 lines
2.1 KiB
Markdown
62 lines
2.1 KiB
Markdown
# Быстрый старт
|
|
|
|
## Установка
|
|
|
|
Нужен Python 3.10+.
|
|
|
|
```bash
|
|
pip install -e .
|
|
# или
|
|
poetry install
|
|
```
|
|
|
|
Для продолжения таблиц/листингов через Word COM (режим `word` по умолчанию) на Windows:
|
|
|
|
```bash
|
|
pip install pywin32
|
|
```
|
|
|
|
Нужны установленный Microsoft Word.
|
|
|
|
## Запуск
|
|
|
|
```bash
|
|
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. При необходимости: Настройки → Файлы (титул, задание), Настройки → Диаграммы, меню «Шаблоны UML».
|
|
4. Нажмите «Конвертировать».
|
|
|
|
Справка в меню: **Инструкция**, **Схемы**, **Промпт для ИИ**.
|
|
|
|
## Типы документов (кратко)
|
|
|
|
| `--type` | Назначение |
|
|
|----------|------------|
|
|
| `practice` / `coursework` | Практика / курсовая по ТЗ МИРЭА |
|
|
| `vkr` | ВКР (раздельный список, графическое приложение) |
|
|
| `PIS_custom` | Итоговый отчёт по практическим работам |
|
|
| `APID_coursework` | Курсовая «Архитектура приложений и данных» |
|
|
|
|
Подробнее: [types.md](types.md).
|
|
|
|
## Следующие шаги
|
|
|
|
- Написать отчёт в диалекте md2gost: [markdown.md](markdown.md)
|
|
- Вставить диаграммы: [schemes.md](schemes.md)
|
|
- Сгенерировать `.md` через ИИ: [prompts.md](prompts.md)
|