Skip to content

Commit

Permalink
docs: update README [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexaraWu committed Oct 21, 2024
1 parent c45a630 commit 50bdacc
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 10 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,21 @@ git clone https://mirror.sjtu.edu.cn/git/SJTUThesis.git/

## 模板使用

如果你不熟悉 LaTeX 的编译流程,**不要**直接使用编译器进行编译。针对不同的平台,模版提供了相应的编译脚本。在编译前,需要安装最新的 TeXLive 发行版。
如果你不熟悉 LaTeX 的编译流程,请参考以下说明编译文档。在编译前,需要安装最新的 TeXLive 发行版。

### VSCode 用户
### 使用编辑器

安装 “LaTeX Workshop” 后,选择 `Recipe: latexmk (xelatex)` 编译即可,并在设置中将 `latex-workshop.latex.recipe.default` 改为 `lastUsed` 以一直使用该选项编译。
#### VS Code

### Linux 与 macOS 用户
安装 “LaTeX Workshop” 扩展,选择预设配方 `Recipe: latexmk (xelatex)` 编译即可;也可以在设置中将 `latex-workshop.latex.recipe.default` 改为 `latexmk (xelatex)` 将其设置为默认选项。

#### TeXstudio

模板内置 TeXstudio 魔术注释,可开箱即用。

### 使用脚本

#### Linux 与 macOS

推荐使用模版提供的 `Makefile` 进行编译,具体来说我们提供了如下几条可用的命令:

Expand All @@ -54,7 +62,7 @@ make cleanall # 删除 main.pdf 和所有中间文件
make wordcount # 论文字数统计
```

### Windows 用户
#### Windows

对于 Windows 用户,我们也提供了编译脚本 `Compile.bat`。可以双击直接编译,也可以在命令提示符窗口中使用脚本提供的额外功能:

Expand All @@ -65,7 +73,7 @@ make wordcount # 论文字数统计
.\Compile.bat wordcount # 论文字数统计
```

更多关于模板的实现细节以及使用信息,请查看使用文档 `sjtuthesis.pdf`
更多关于模板的实现细节以及使用信息,请查看使用文档 [`sjtutex.pdf`](https://mirrors.sjtug.sjtu.edu.cn/ctan/macros/latex/contrib/sjtutex/sjtutex.pdf)

## 反馈与贡献

Expand Down
24 changes: 20 additions & 4 deletions README_en-US.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Sample Template of SJTUThesis

[![Build Status](https://github.com/sjtug/SJTUThesis/actions/workflows/build.yml/badge.svg)](https://github.com/sjtug/SJTUThesis/actions)
[![SJTUTeX](https://img.shields.io/github/v/release/sjtug/SJTUTeX?label=SJTUTeX)](https://github.com/sjtug/SJTUTeX)
[![SJTUTeX](https://img.shields.io/github/v/release/sjtug/SJTUTeX?label=SJTUTeX)](https://github.com/sjtug/SJTUTeX)
[![Join Discussions](https://img.shields.io/github/discussions/sjtug/SJTUThesis)](https://github.com/sjtug/SJTUThesis/discussions)

## Welcome to LaTeX thesis template for Shanghai Jiao Tong University
Expand All @@ -17,7 +17,7 @@ Please note that `sjtuthesis` supports both XeTeX and LuaTeX engine, `sjtuthesis
You can `clone` this repository directly or download it from [GitHub](https://github.com/sjtug/SJTUThesis).

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

### Online LaTeX Editor
Expand All @@ -30,7 +30,21 @@ You can create your own project through the link above.

## Usage

### Linux & macOS Users
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.

Expand All @@ -41,7 +55,7 @@ make cleanall # remove everything produced by make all
make wordcount # count the words of the thesis
```

### Windows Users
#### 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.

Expand All @@ -52,6 +66,8 @@ We also provided a batch script `Compile.bat` for Windows users. You can double-
.\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`](https://mirrors.sjtug.sjtu.edu.cn/ctan/macros/latex/contrib/sjtutex/sjtutex.pdf).

## Feedback

We are hearing from:
Expand Down

0 comments on commit 50bdacc

Please sign in to comment.