Skip to content

Commit

Permalink
docs: installation info (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
LogCreative authored Jun 7, 2023
1 parent cd4ae5e commit 6f1d6c6
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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` 中,需要解包之后才能够使用。
Expand All @@ -33,6 +44,8 @@ l3build doc <sample>
l3build doc sjtutex
```

> 请注意文档类文档 `sjtutex.pdf` 的正确编译需要使用 Noto CJK 字体(即 `ctex` 字体配置中的 `fontset=ubuntu`)。
在您提交 PR 时,GitHub Action 会自动构建文档 PDF。

## 软件许可证
Expand Down

0 comments on commit 6f1d6c6

Please sign in to comment.