update readme

3. [讨论区 Discussions](https://github.com/SUSTech-CRA/sustech-master-thesis/discussions)

## 使用

### Windows 中编译

1. `build.bat` 构建PDF文件；

2. `clean.bat` 清理编译时生成的中间文件。

### Windows 中编译，使用 `latexmk`

1. `latexmk sustechthesis-example.tex` 生成示例论文 sustechthesis-example.pdf；

2. `latexmk sustechthesis.dtx` 生成说明文档 sustechthesis.pdf；

3. `latexmk -c` 清理编译生成的辅助文件；

### 使用 Makefile 编译

* `make thesis`     生成论文；

* `make thesis`     生成文档；

* `make viewthesis` 生成论文，编译完成开启预览；

* `make all`        生成论文，与 `make thesis` 等效；

* `make clean`      删除示例文件的中间文件（不含 pdf）；

* `make cleanall`   删除示例文件的中间文件和 pdf；

* `make wordcount`  论文字数统计。

* `make doc`     生成文档；

* `make cls`        仅生成 cls 模版类文件；

### 使用 LaTex 在线编辑器

* 使用 [Overleaf](https://www.overleaf.com/)（需要科学上网保证稳定使用），上传 zip 压缩包后，更改编译器为 `XeLaTex`

* 使用 南科大[ShareLaTex](https://sharelatex.cra.moe/)，使用方式与Overleaf相同，上传 zip 压缩包后，更改编译器为 `XeLaTex`，并在主文档的头部 `\documentclass[degree=master,language=english,fontset=fandol]` 设置 `fontset` 参数 为 `fandol`.

* 使用 [南科大 ShareLaTex](https://sharelatex.cra.moe/)，使用方式与Overleaf相同，上传 zip 压缩包后，更改编译器为 `XeLaTex`，并在主文档的头部 `\documentclass[degree=master,language=english,fontset=fandol]` 设置 `fontset` 参数 为 `fandol`.

### 编译前的建议

1. 在撰写论文时，我们不推荐使用原有的 `sustechthesis-example.tex` 这一名称。建议将其复制一份，改为其他的名字(如 `thesis.tex` 或者 `main.tex`)。需要注意，如果使用了来 自 `data` 目录中的 `tex` 文件，则重命名主文件后，其顶端的 `!TeX root` 选项也需要相应修改。

2. 需要注意，如果更改了主文件的名称，则需要修改 `Makefile` 顶端的 `THESIS` 变量定义；或修改 `build.bat` 和 `clean.bat` 中 `latexmk` 命令后的参数。

2. 需要注意，如果更改了主文件的名称，则需要修改 `Makefile` 顶端的 `THESIS` 变量定义；或修改 `latexmk` 命令后的参数。

3. ⚠️ 提交最终正式版本时，建议在 Windows 下本地编译且设置 `fontset` 参数 为 `windows`，以保证字体正确。

## 模板结构