Rename project and binary to DocxGenerator

This commit is contained in:
2026-10-03 23:47:55 +04:00
parent 3a8045a141
commit 41d434ef97
7 changed files with 27 additions and 27 deletions

View File

@@ -1,6 +1,6 @@
# AGENTS.md — генератор lab-gen
# AGENTS.md — генератор DocxGenerator
`lab-gen` — автономный инструмент, который собирает отчёт в формате **DOCX** из обычных
`DocxGenerator` — автономный инструмент, который собирает отчёт в формате **DOCX** из обычных
**Markdown**-файлов по фиксированному дизайну СТО 02068410-004-2018. Поведение полностью
задаётся файлом `config.yaml`.
@@ -18,7 +18,7 @@
## 2. Состав дистрибутива
```
lab-gen.exe # исполняемый файл
DocxGenerator.exe # исполняемый файл
config.yaml # настройки (создаётся автоматически при первом запуске)
content/ # Markdown-файлы документа и ресурсы
*.md
@@ -29,12 +29,12 @@ report.docx # результат сборки (путь задаё
```
Все относительные пути в `config.yaml` считаются **от каталога самого `config.yaml`**.
Сам `config.yaml` и папки ищутся **рядом с `lab-gen.exe`**.
Сам `config.yaml` и папки ищутся **рядом с `DocxGenerator.exe`**.
## 3. Командная строка
```
lab-gen [опции]
DocxGenerator [опции]
--config <путь> путь к config.yaml (по умолчанию рядом с exe)
--content <dir> каталог с config.yaml, content/ и assets/ (по умолчанию рядом с exe)
@@ -56,10 +56,10 @@ lab-gen [опции]
Типичный цикл работы:
```powershell
.\lab-gen.exe --init # первый запуск: получить шаблон
.\DocxGenerator.exe --init # первый запуск: получить шаблон
# ... правим config.yaml и content/*.md ...
.\lab-gen.exe --check # проверить
.\lab-gen.exe # собрать report.docx
.\DocxGenerator.exe --check # проверить
.\DocxGenerator.exe # собрать report.docx
```
## 4. Схема `config.yaml`
@@ -288,7 +288,7 @@ a — коэффициент.
## 6. Проверка и ошибки
`lab-gen --check` проверяет:
`DocxGenerator --check` проверяет:
- корректность `config.yaml` (типы, существование файлов, допустимые буквы приложений);
- наличие всех `sections[].file`;
@@ -302,7 +302,7 @@ a — коэффициент.
```powershell
npm install
npm run build:exe # -> lab-gen.exe в корне (target node24-win-x64)
npm run build:exe # -> DocxGenerator.exe в корне (target node24-win-x64)
npm run generate # локальная сборка (node src/cli.js)
npm run check # проверка конфига и ссылок
```