Initial commit

docs/examples/README.md

@@ -0,0 +1,28 @@
+# Компилируемые примеры
+
+Примеры одновременно служат учебными материалами и полными заготовками. Каждый каталог документа содержит собственные `main.typ`, `chapters/` и при необходимости `assets/`, поэтому его можно собрать на месте или установить задачей VS Code.
+
+## Виды документов
+
+| Пример | Что показывает | Команда |
+|--------|---------------|---------|
+| [Отчёт](documents/report/main.typ) | Титул, этап, исполнители, рисунки, таблицы, формулы, библиография и отдельные файлы приложений | `typst compile --root . docs/examples/documents/report/main.typ example.pdf` |
+| [Письмо](documents/letter/main.typ) | Адресат, исходящий номер, текст, подпись и перечень приложений | `typst compile --root . docs/examples/documents/letter/main.typ example.pdf` |
+| [ТКП](documents/commercial-offer/main.typ) | Предмет, цена, сроки, оплата, состав работ и техническое задание | `typst compile --root . docs/examples/documents/commercial-offer/main.typ example.pdf` |
+| [Договор](documents/contract/main.typ) | Стороны, представители, разделы, реквизиты, подписи и приложение | `typst compile --root . docs/examples/documents/contract/main.typ example.pdf` |
+
+## Каталог оформления
+
+[formatting/main.typ](formatting/main.typ) содержит пояснённые варианты рисунков, сеток изображений, простых и сложных таблиц, CSV, формул, ссылок и списков.
+
+## Пример настроек приватных данных
+
+[private/settings.typ](private/settings.typ) показывает полный формат локальных настроек без настоящих изображений. Скопируйте его в `.private/settings.typ`, но меняйте `enabled` на `true` только после добавления соответствующего PNG.
+
+## Установка примера в корень
+
+Запустите **Scientia: выбрать тип документа**. Задача:
+
+1. сохранит текущие `main.typ` и `chapters/` в `.private/starter-backups/`;
+2. скопирует выбранный пример в корень;
+3. оставит три варианта режима комментариями внутри нового `main.typ`.