summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/shtthesis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/shtthesis/README.md')
-rw-r--r--macros/latex/contrib/shtthesis/README.md19
1 files changed, 12 insertions, 7 deletions
diff --git a/macros/latex/contrib/shtthesis/README.md b/macros/latex/contrib/shtthesis/README.md
index cbb743db2a..582318cdbf 100644
--- a/macros/latex/contrib/shtthesis/README.md
+++ b/macros/latex/contrib/shtthesis/README.md
@@ -1,9 +1,12 @@
# ShangHaiTech university THESIS (shtthesis)
-![Build](https://github.com/lirundong/sht-thesis/workflows/Build/badge.svg)
+[![Action status](https://github.com/lirundong/sht-thesis/workflows/Build/badge.svg)](https://github.com/lirundong/shtthesis/actions)
+[![CTAN version](https://img.shields.io/ctan/v/shtthesis)](https://ctan.org/pkg/shtthesis)
+[![GitHub release](https://img.shields.io/github/v/release/lirundong/shtthesis)](https://github.com/lirundong/shtthesis/releases/latest)
+[![GitHub downloads](https://img.shields.io/github/downloads/lirundong/shtthesis/total)](https://github.com/lirundong/shtthesis/releases)
-`shtthesis` project, forked from [`ucasthesis`](https://github.com/mohuangrui/ucasthesis), is an **unofficial** LaTeX thesis template for ShanghaiTech University and satisfies all format requirements in 《上海科技大学研究生学位论文撰写规范(初稿)》. The user just need to set `\documentclass{shtthesis}` and to setup mandatory information via `\shtsetup`, then his or her thesis document will be typeset properly:
+`shtthesis` project, forked from [`ucasthesis`](https://github.com/mohuangrui/ucasthesis), is an **unofficial** LaTeX thesis template for ShanghaiTech University and satisfies all format requirements of graduate/undergraduate thesis. The user just need to set `\documentclass{shtthesis}` and to setup mandatory information via `\shtsetup`, then his or her thesis document will be typeset properly:
```latex
-\documentclass{shtthesis}
+\documentclass[master]{shtthesis}
\shtsetup{
title = {论文标题},
@@ -19,10 +22,13 @@
## Get the Template
- Stable version:
- - GitHub Release: please refer to [release](https://github.com/lirundong/sht-thesis/releases) page, and download required files based on release information
- - CTAN: TODO
+ - CTAN (**strongly recommended**): [`shtthesis`](https://ctan.org/pkg/shtthesis) package on CTAN can be installed via `tlmgr` for TeX Live and MacTeX users:
+ ```bash
+ tlmgr install shtthesis
+ ```
- Note that `shtthesis` package in CTAN does not include the university logo file. Please download [`shanghaitech-logo.pdf`](shanghaitech-logo.pdf) from this repository and put it in the root of your project folder.
+ **Note**: `shtthesis` package on CTAN does not include the university logo file. Please download [`shanghaitech-logo.pdf`](https://github.com/lirundong/shtthesis/raw/master/shanghaitech-logo.pdf) from this repository and put it in the root of your project directory.
+ - GitHub Release: please refer to [release](https://github.com/lirundong/sht-thesis/releases) page, and download required files based on release information
- Develop version: directly clone the GitHub repo
```bash
git clone https://github.com/lirundong/sht-thesis.git
@@ -47,5 +53,4 @@ After cloning or downloading this template, please
## License
- The copyright of ShanghaiTech University logo (`shanghaitech-logo.pdf`) is owned by ShanghaiTech University
-- `shtthesis-gbt7714-plain.bst` is modified from [gbt7714](https://github.com/CTeX-org/gbt7714-bibtex-style) project and is licensed under LaTeX Project Public License v1.3c, see [lppl-1.3c](https://www.latex-project.org/lppl/lppl-1-3c.txt) for details
- The rest of `shtthesis` project is licensed under GNU Public License v3, see [LICENSE](LICENSE) for details