shtthesis project, forked from 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:

\documentclass[master]{shtthesis}

\shtsetup{
  title = {论文标题},
  title* = {Title~of~Thesis},
  author = {作者姓名},
  author* = {Name~of~Author},
  % ...
}

\begin{document}
% ...

• Stable version: Install or download with any of following methods

  • CTAN (highly recommended): shtthesis package on CTAN can be installed via tlmgr for TeX Live and MacTeX users:

    tlmgr install shtthesis

    If your distribution already contains shtthesis, please update it to the latest version:

    tlmgr update shtthesis

    Note: shtthesis package on CTAN does not include the university logo file. Please download shanghaitech-emblem.pdf from this repository and put it in the root of your project directory.

  • Overleaf: 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

  • GitHub Release: Please refer to the release page and download required files based on release information

• Develop version: Directly clone the GitHub repo

  git clone https://github.com/lirundong/shtthesis.git

Please, read through the user's guide before continuing.

After cloning or downloading this template, please

0. Install a modern TeX distribution in full scheme:
   • Windows or Linux: TeX Live
   • macOS: MacTeX
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):

   latexmk -pdflua
   # if you prefer XeLaTeX engine:
   # latexmk -pdfxe

   the output file shtthesis-user-guide.pdf is the compiled user guide document
2. Open the document source file shtthesis-user-guide.tex and enjoy TeXing 😏

• The copyright of ShanghaiTech University logo (shanghaitech-emblem.pdf) is owned by ShanghaiTech University
• The rest of shtthesis project is licensed under GNU Public License v3, see LICENSE for details