Skip to content

Commit

Permalink
[docs] 更新文档, 准备更新版本 (sjtug#264)
Browse files Browse the repository at this point in the history
Signed-off-by: Ce Gao <[email protected]>
  • Loading branch information
gaocegege committed Jan 9, 2018
1 parent 0b72d16 commit 3b02359
Showing 1 changed file with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,40 @@
# 上海交通大学学位论文模板

[![Build Status](https://travis-ci.org/sjtug/SJTUThesis.svg?branch=master)](https://travis-ci.org/sjtug/SJTUThesis)
[![](https://img.shields.io/github/release/sjtug/SJTUThesis.svg)](https://github.com/sjtug/SJTUThesis/releases)
[![GitHub Release](https://img.shields.io/github/release/sjtug/SJTUThesis.svg)](https://github.com/sjtug/SJTUThesis/releases)
[![GitHub Release Date](https://img.shields.io/github/release-date/sjtug/SJTUThesis.svg)]()

这是为撰写上海交通大学学士、硕士或博士论文而准备的 XeLaTeX 模板,非官方出品。生成的学位论文文件参见 [README.pdf][README],详细使用说明参见 [SJTUThesis Wiki](https://github.com/sjtug/SJTUThesis/wiki),欢迎大家分享使用经验
这是为撰写上海交通大学学士、硕士或博士论文而准备的 XeLaTeX 模板,非官方出品。生成的学位论文文件参见 [README.pdf][README],详细使用说明参见 [SJTUThesis Wiki](https://github.com/sjtug/SJTUThesis/wiki)

## 如何使用

SJTUThesis 可以在本地编译,也可以在线编译。

### 本地编译 - 系统需求
### 本地编译

本地编译需要依赖一个可用的 LaTeX 发行版, 以及中文字体的支持。

#### TeX 发行版

SJTUThesis 需要使用 XeTeX 引擎编译。Linux 用户可以安装 [TeX Live](https://www.tug.org/texlive/),MacOS 用户可以安装 [MacTeX](https://www.tug.org/mactex/),Windows 用户可以安装 [CTeX 套装(包含完整版 MiKTeX)](http://www.ctex.org/CTeXDownload)
SJTUThesis 需要使用 XeTeX 引擎编译。,Windows 和 Linux 用户可以安装 [TeX Live](https://www.tug.org/texlive/),MacOS 用户可以安装 [MacTeX](https://www.tug.org/mactex/)。详细请参见[本地安装使用说明](https://github.com/sjtug/SJTUThesis/wiki/%E6%9C%AC%E5%9C%B0%E5%AE%89%E8%A3%85%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E)

注:**Windows 用户**推荐使用 [Babun](http://babun.github.io/) 作为命令行终端。Babun 已默认安装有这些工具:git(用于版本控制)、GNUmake(用于编译控制)、perl(用于字数统计)。

#### 中文字体

SJTUThesis 由 [CTeX](https://www.ctan.org/pkg/ctex?lang=en) 宏集提供中文支持,默认情况下可以自动检测操作系统选择字体配置,同时 CTeX 宏集也提供了相应选项以供在自动配置失效或用户有特殊需求的情况下使用。

### 获取模板
#### 获取模板

根据「系统需求」中情形选择适合你系统情况的分支,然后根据情况选择 git 克隆最新版代码或者下载稳定版压缩包。

#### 终端中克隆最新版
##### 压缩包下载

[![GitHub Release](https://img.shields.io/github/release/sjtug/SJTUThesis.svg)](https://github.com/sjtug/SJTUThesis/releases)

你可以在 [GitHub Release](https://github.com/sjtug/SJTUThesis/releases) 中找到 SJTUThesis 的所有版本,推荐使用最新版本以避免一些问题。

##### 终端中克隆最新版

```shell
git clone https://github.com/sjtug/SJTUThesis.git
Expand All @@ -44,15 +52,9 @@ git pull origin master
git pull upstream master
```

#### 压缩包下载

SJTUThesis 提供了多个稳定版供您使用,这些版本的输出结果具有相近的外观,但依赖不同的 TeXLive 发行版和参考文献处理程序。

| TeXLive发行版 | 参考文献风格 | SJTUThesis版本 |
|---------------|---------------|----------------|
| 2016,2017 | GB7714 | [0.9.5][0.9.5] |
#### 编译模板

### 编译模板
##### 在 Linux 与 macOS 上编译

编译模板,生成学位论文 PDF 文件。GNUMake 将调用 `latexmk` 程序,自动完成模板的多轮编译。

Expand All @@ -68,17 +70,17 @@ make cleanall thesis.pdf

若需要生成用于提交盲审的论文(隐去作者、导师等信息),可在 `thesis.tex` 中为 `sjtuthesis` 文档类添加 `review` 选项。 若需要生成包含“原创性声明扫描件”和“授权书”签名扫描件的学位论文,请将扫描件分别保存为 `pdf/origignal.pdf``pdf/authorization.pdf`,然后添加 `submit` 选项重新编译模板。

#### Windows用户编译
##### 在 Windows 上编译

双击 `compile.bat` 即可完成编译过程,生成 `thesis.pdf`,不依赖于 GNUMake
双击 `compile.bat` 即可完成编译过程,生成 `thesis.pdf`

### 字数统计
#### 字数统计

```shell
make wordcount
```

### 问题诊断
#### 问题诊断

编译失败时,可以尝试手动逐次编译。
结合文档 [README.pdf][README] 中的说明,有助于定位故障。
Expand All @@ -90,7 +92,7 @@ xelatex thesis
xelatex thesis
```

## ShareLaTeX
### ShareLaTeX 在线编译

[![](https://img.shields.io/badge/ShareLaTeX-v0.8-green.svg)](https://www.sharelatex.com/templates/566ea0fb08f4ac510fbc6b9e)
[![](https://img.shields.io/badge/ShareLaTeX-v0.9.5-green.svg)](https://www.sharelatex.com/templates/588163ec93a02abc513710fd)
Expand All @@ -101,7 +103,7 @@ xelatex thesis

建议以如下的顺序反馈使用问题:

* [在 GitHub 项目主页开 issue](https://github.com/sjtug/SJTUThesis/issues)
* [在 GitHub 项目主页开 issue](https://github.com/sjtug/SJTUThesis/issues) (推荐)
* [在水源 BBS TeX_LaTeX 版发帖](https://bbs.sjtu.edu.cn/bbsdoc?board=TeX_LaTeX)

## 后续工作计划
Expand Down

0 comments on commit 3b02359

Please sign in to comment.