summaryrefslogtreecommitdiff
path: root/macros/xetex/latex/xduts/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/xetex/latex/xduts/README.md')
-rw-r--r--macros/xetex/latex/xduts/README.md46
1 files changed, 36 insertions, 10 deletions
diff --git a/macros/xetex/latex/xduts/README.md b/macros/xetex/latex/xduts/README.md
index 2915333371..f4e54ed187 100644
--- a/macros/xetex/latex/xduts/README.md
+++ b/macros/xetex/latex/xduts/README.md
@@ -2,18 +2,40 @@
[![](https://img.shields.io/ctan/v/xduts)](https://www.ctan.org/pkg/xduts) [![](https://img.shields.io/github/license/note286/xduts)](https://github.com/note286/xduts/blob/main/LICENSE) [![](https://img.shields.io/github/stars/note286/xduts)](https://github.com/note286/xduts) [![](https://img.shields.io/github/issues/note286/xduts)](https://github.com/note286/xduts/issues?q=is%3Aopen+is%3Aissue) [![](https://img.shields.io/github/issues-closed/note286/xduts)](https://github.com/note286/xduts/issues?q=is%3Aissue+is%3Aclosed) [![](https://img.shields.io/github/commit-activity/m/note286/xduts)](https://github.com/note286/xduts/commits/main) [![](https://img.shields.io/github/v/tag/note286/xduts)](https://github.com/note286/xduts/tags)
-XDUTS(Xidian University TeX Suite)是面向西安电子科技大学本科生/研究生的LaTeX3文档类和宏包套装,支持XeLaTeX,支持TeX Live、MacTeX、MiKTeX,支持Windows、macOS、GNU/Linux、Overleaf和TeXPage。旨在帮助西安电子科技大学本科生/研究生撰写开题报告/学位论文及其他文档,目前有:
+XDUTS (Xidian University TeX Suite) is a LaTeX3 document class and package suite for undergraduate/postgraduate students in Xidian University, which can be compiled with XeLaTeX on Windows, macOS, GNU/Linux, Overleaf, and TeXPage. It is designed to typesetting proposal/thesis and other documents.
-- xduugthesis,本科毕业设计论文文档类
-- xdufont,中/英/数学字体配置宏包
+XDUTS currently includes:
-即将支持:
+- `xduugthesis.cls`, Xidian University Undergraduate Thesis document class
+- `xdufont.sty`, Xidian University Font package
-- xduugtp,本科生开题报告文档类
-- xdupgthesis,研究生学位论文文档类
-- xdupgtp,研究生开题报告文档类
+In the future, we plan to add the following document classes, including
-## 获取
+- `xduugtp.cls`, Xidian University Undergraduate Thesis Proposal document class
+- `xdupgtp.cls`, Xidian University Postgraduate Thesis Proposal document class
+- `xdupgthesis.cls`, Xidian University Postgraduate Thesis document class
+
+## Installation
+
+You can install XDUTS by either CTAN or GitHub by following the instructions below.
+
+### CTAN
+
+Make sure the latest version of TeX Live/MacTeX is installed. Then, you can install XDUTS by running command below. If on Windows, it may be necessary to start a Command Prompt as an Administrator. If on macOS or GNU/Linux, please run the command with `sudo`.
+
+```shell
+tlmgr update xduts
+```
+
+Run command below to open the documentation in TeX Live/MacTeX.
+
+```shell
+texdoc xduts
+```
+
+### GitHub
+
+Generally speaking, CTAN updates XDUTS slowly. If you want to use the latest version of XDUTS, download this repository and run the following commands to get the corresponding documentation and document class/package files.
```shell
xetex xduts.ins
@@ -24,6 +46,10 @@ xelatex xduts.dtx
xelatex xduts.dtx
```
-## 许可
+## Note
+
+`xidian-text.pdf` and `xidian-logo.pdf` should be placed in the same directory as `xduugthesis.cls`.
+
+## License
-This material is subject to [the LaTeX Project Public License 1.3c](https://ctan.org/license/lppl1.3).
+XDUTS is subject to [the LaTeX Project Public License 1.3c](https://ctan.org/license/lppl1.3).