README_en-US.md

Sample Template of SJTUThesis

Welcome to LaTeX thesis template for Shanghai Jiao Tong University

This sample template is a full implementation of SJTUThesis document class which is an LaTeX class for preparing degree theses or course papers at Shanghai Jiao Tong University.

Please note that sjtuthesis supports both XeTeX and LuaTeX engine, sjtuthesis only allows UTF-8 character encoding.

Obtain Template

Downloads

You can clone this repository directly or download it from GitHub.

git clone https://github.com/sjtug/SJTUThesis.git

Online LaTeX Editor

You can create your own project through the link above.

Usage

If you are not familiar with the LaTeX compilation process, please follow the instructions below to compile the document. Before compiling, you need to install the latest TeXLive distribution.

Compile with Editors

VS Code

Install the "LaTeX Workshop" extension, select the preset recipe Recipe: latexmk (xelatex) to compile; you can also change latex-workshop.latex.recipe.default to latexmk (xelatex) in the settings to set it as the default option.

TeXstudio

The template has built-in TeXstudio magic comments, can be used out of the box.

Compile with Scripts

Linux & macOS

It is recommended to use GNU make utility with Makefile provided in the template.

make all                      # compile and generate main.pdf
make clean                    # remove useless files
make cleanall                 # remove everything produced by make all
make wordcount                # count the words of the thesis

Windows

We also provided a batch script Compile.bat for Windows users. You can double-click the batch file to compile instantly, or use it in Command Prompt to access extra features.

.\Compile.bat thesis          # compile and generate main.pdf
.\Compile.bat clean           # remove useless files
.\Compile.bat cleanall        # remove everything produced by make all
.\Compile.bat wordcount       # count the words of the thesis

For more information about the implementation and usage of the template, please refer to the document sjtutex.pdf.

Feedback

We are hearing from:

• Discussions page of GitHub (Recommended for usage problems)
• Issues page of GitHub

License

The copyright of image sources including SJTU logo (sjtu-vi-logo-blue.pdf etc.) belongs to Shanghai Jiao Tong University.

sjtuthesis.cls document class with related files are under LPPL.

The remaining parts are under Apache License 2.0.