initial commit

README.md

@@ -0,0 +1,36 @@
+# Шаблон для лабораторных работ
+
+Данный репозиторий представляет собой шаблон для отчёта о лабораторных работах на [Typst](https://github.com/typst/typst).
+
+Сделан, т.к. форматы Microsoft, вроде Word, ужасны и неудобны, а LaTex довольно сложный для освоения и вёрстки. Typst достаточно простой и эффективный для данной задачи.
+
+# Структура
+
+## `main.typ`
+
+Есть главный файл `main.typ` - он нужен лишь для включения других файлов. В нём прописаны лишь основные параметры отчёта вроде отступа, шрифта, размера и т.д.
+
+## `config/`
+
+В `config` лежат параметры отчёта. В файле `config/variables.typ` данные о лабораторной работе, включая имя студента, имя преподавателя, тему лабораторной, номер и т.д. Проще зайти самому и поменять.
+
+## `pages/`
+
+В `pages` находятся страницы отчёта.
+
+Трогать `title_page.typ` не стоит - в нём титульник работы, где всё построено на переменных. Менять только если с вашими данными титульник содержит ошибки, вроде несовпдадения падежей.
+
+В `content.typ` лежит основное содержание отчёта. Он предназначен для изменения.
+
+## `img`
+
+Данная директория опциональна, в ней будут лежать изображения для отчёта.
+
+# Формирование отчёта
+
+Отчёт формируется просто компиляцией документа:
+```bash
+typst compile main.typ
+```
+
+Typst умеет компилироваться в PDF, HTML, PNG, SVG (лучше следите в источниках самого Typst).