| 1 |
# ShangHaiTech university THESIS (shtthesis) |
| 2 |
[](https://github.com/lirundong/shtthesis/actions) |
| 3 |
[](https://github.com/lirundong/shtthesis/releases/latest) |
| 4 |
[](https://ctan.org/pkg/shtthesis) |
| 5 |
[](https://www.overleaf.com/latex/templates/shanghaitech-university-thesis-template/mskbxkmfxqpt) |
| 6 |
|
| 7 |
`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: |
| 8 |
```latex |
| 9 |
\documentclass[master]{shtthesis} |
| 10 |
|
| 11 |
\shtsetup{ |
| 12 |
title = {论文标题}, |
| 13 |
title* = {Title~of~Thesis}, |
| 14 |
author = {作者姓名}, |
| 15 |
author* = {Name~of~Author}, |
| 16 |
% ... |
| 17 |
} |
| 18 |
|
| 19 |
\begin{document} |
| 20 |
% ... |
| 21 |
``` |
| 22 |
|
| 23 |
## Get the Template |
| 24 |
- Stable version: Install or download with any of following methods |
| 25 |
- CTAN (**highly recommended**): [`shtthesis`](https://ctan.org/pkg/shtthesis) package on CTAN can be installed via `tlmgr` for TeX Live and MacTeX users: |
| 26 |
```bash |
| 27 |
tlmgr install shtthesis |
| 28 |
``` |
| 29 |
If your distribution already contains `shtthesis`, please update it to the latest version: |
| 30 |
```bash |
| 31 |
tlmgr update shtthesis |
| 32 |
``` |
| 33 |
|
| 34 |
**Note**: `shtthesis` package on CTAN does not include the university logo file. Please download [`shanghaitech-emblem.pdf`](https://github.com/lirundong/shtthesis/raw/v0.3/shanghaitech-emblem.pdf) from this repository and put it in the root of your project directory. |
| 35 |
- [Overleaf](https://www.overleaf.com/latex/templates/shanghaitech-university-thesis-template/mskbxkmfxqpt): Please compile with XeLaTeX. Since compilation time for Overleaf free-plan is limited to *1 minute*, you might encounter with timeout issue if compiling with LuaLaTeX |
| 36 |
- GitHub Release: Please refer to the [release](https://github.com/lirundong/shtthesis/releases) page and download required files based on release information |
| 37 |
- Develop version: Directly clone the GitHub repo |
| 38 |
```bash |
| 39 |
git clone https://github.com/lirundong/shtthesis.git |
| 40 |
``` |
| 41 |
|
| 42 |
Please, read through [the user's guide](http://mirrors.ctan.org/macros/latex/contrib/shtthesis/shtthesis-user-guide.pdf) before continuing. |
| 43 |
|
| 44 |
## Get Started |
| 45 |
After cloning or downloading this template, please |
| 46 |
|
| 47 |
0. Install a modern TeX distribution **in full scheme**: |
| 48 |
- Windows or Linux: [TeX Live](https://www.tug.org/texlive/) |
| 49 |
- macOS: [MacTeX](https://www.tug.org/mactex/) |
| 50 |
1. Open your terminal (CMD for Windows users) and switch to this directory, compile this template by `latexmk` tool with LuaLaTeX or XeLaTeX engine (**note**: pdfLaTeX is not supported): |
| 51 |
```bash |
| 52 |
latexmk -pdflua |
| 53 |
# if you prefer XeLaTeX engine: |
| 54 |
# latexmk -pdfxe |
| 55 |
``` |
| 56 |
the output file `shtthesis-user-guide.pdf` is the compiled user guide document |
| 57 |
2. Open the document source file [shtthesis-user-guide.tex](shtthesis-user-guide.tex) and enjoy TeXing :smirk: |
| 58 |
|
| 59 |
## License |
| 60 |
- The copyright of ShanghaiTech University logo (`shanghaitech-emblem.pdf`) is owned by ShanghaiTech University |
| 61 |
- The rest of `shtthesis` project is licensed under GNU Public License v3, see [LICENSE](LICENSE) for details |