From 6f1d6c686944cbf81ae4a6e2208ae6235735198a Mon Sep 17 00:00:00 2001 From: LogCreative Date: Wed, 7 Jun 2023 22:48:03 +0800 Subject: [PATCH] docs: installation info (#43) --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6df0ee32..d6695a06 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,17 @@ SJTUTeX 是 [SJTUThesis](https://github.com/sjtug/SJTUThesis) 项目使用的宏 SJTUTeX 和 SJTUThesis 项目共享讨论区与社区写作模式。如遇问题,请在 [SJTUThesis](https://github.com/sjtug/SJTUThesis) 中反馈。 +## 安装至发行版 + +如果你正在使用 TeX Live 或 MacTeX,可以在终端输入下面的命令安装至本地发行版中。 + +```bash +cd sjtutex +l3build install +``` + +也可以将[发布区](https://github.com/sjtug/SJTUTeX/releases/latest)的 `sjtutex.tds.zip` 手动解压到发行版的 TDS 目录下。 + ## 开发指南 文档类主要代码在 `sjtutex.dtx` 中,需要解包之后才能够使用。 @@ -33,6 +44,8 @@ l3build doc l3build doc sjtutex ``` +> 请注意文档类文档 `sjtutex.pdf` 的正确编译需要使用 Noto CJK 字体(即 `ctex` 字体配置中的 `fontset=ubuntu`)。 + 在您提交 PR 时,GitHub Action 会自动构建文档 PDF。 ## 软件许可证