diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/thuthesis/README.md |
Initial commit
Diffstat (limited to 'macros/latex/contrib/thuthesis/README.md')
-rw-r--r-- | macros/latex/contrib/thuthesis/README.md | 104 |
1 files changed, 104 insertions, 0 deletions
diff --git a/macros/latex/contrib/thuthesis/README.md b/macros/latex/contrib/thuthesis/README.md new file mode 100644 index 0000000000..ff9a88378d --- /dev/null +++ b/macros/latex/contrib/thuthesis/README.md @@ -0,0 +1,104 @@ +[![Build Status](https://travis-ci.org/xueruini/thuthesis.svg?branch=master)](https://travis-ci.org/xueruini/thuthesis) +[![Join the chat at https://gitter.im/thuthesis/Lobby](https://badges.gitter.im/thuthesis/Lobby.svg)](https://gitter.im/thuthesis/Lobby) +[![Github downloads](https://img.shields.io/github/downloads/xueruini/thuthesis/total.svg)](https://github.com/xueruini/thuthesis/releases) +[![GitHub release](https://img.shields.io/github/release/xueruini/thuthesis/all.svg)](https://github.com/xueruini/thuthesis/releases/latest) +[![GitHub commits](https://img.shields.io/github/commits-since/xueruini/thuthesis/latest.svg)](https://github.com/xueruini/thuthesis/commits/master) + +# What's ThuThesis? +ThuThesis is an abbreviation of <b>T</b>sing<b>h</b>ua <b>U</b>niversity <b>Thesis</b> LaTeX Template. + +This package establishes a simple and easy-to-use LaTeX template for Tsinghua dissertations, including general undergraduate research papers, masters theses, doctoral theses, doctoral dissertations, and post-doc reports. Additional support for other formats (what else is there?) will be added continuously. An English translation of this README follows the Chinese below. + +# ThuThesis是什么? +ThuThesis为 <b>T</b>sing<b>h</b>ua <b>U</b>niversity <b>Thesis</b> LaTeX Template之缩写。 + +此宏包旨在建立一个简单易用的清华大学学位论文LaTeX模板,包括本科综合论文训练、硕士论文、博士论文、博士哲学论文以及博士后出站报告。现在支持本科、硕士、博士论文、博士后出站报告格式,对其它格式(还有么?)的支持会陆续加入。 + +# 文档 +请[下载](https://github.com/xueruini/thuthesis/releases)模板,里面包括具体使用说明以及示例文档: + +* 模板使用说明 (thuthesis.pdf) +* 示例文档 (main.pdf) + +# 下载 +* 发行版:[CTAN](http://www.ctan.org/pkg/thuthesis) +* 开发版:[GitHub](https://github.com/xueruini/thuthesis) + +# 升级 +## 自动更新 +通过 TeX 发行版工具自动从 [CTAN](http://www.ctan.org/pkg/thuthesis) 更新。 + +## 手动更新 +从 [GitHub](https://github.com/xueruini/thuthesis) 下载放入论文目录,执行命令(Windows 用户在文件夹空白处按`Shift+鼠标右键`,点击“在此处打开命令行窗口”): + + xetex thuthesis.ins + +即可得到 `thuthesis.cls` 等模板文件。 + +# 提问 +按推荐顺序排序: + +* 先到 [FAQ](https://github.com/xueruini/thuthesis/wiki/FAQ) 看看常见问题 +* [Github Issues](http://github.com/xueruini/thuthesis/issues) +* [TeX@newsmth](http://www.newsmth.net/nForum/#!board/TeX) +* [ThuThesis@Google Groups](http://groups.google.com/group/thuthesis) + +# Makefile的用法 + +```shell +make [{all|thesis|shuji|doc|clean|cleanall|distclean}] +``` + +## 目标 +* `make all` 等于 `make thesis && make shuji && make doc`; +* `make cls` 生成模板文件; +* `make thesis` 生成论文 main.pdf; +* `make shuji` 生成书脊 shuji.pdf; +* `make doc` 生成使用说明书 thuthesis.pdf; +* `make clean` 删除示例文件的中间文件(不含 main.pdf); +* `make cleanall` 删除示例文件的中间文件和 main.pdf; +* `make distclean` 删除示例文件和模板的所有中间文件和 PDF。 + +# Documentation +Download and unzip the template. Specific usage documentation and examples can be found in the files below. At present, these documents are <b>only available in Chinese</b>: +* Template usage (thuthesis.pdf) +* Template example (main.pdf) + +# Downloads +* Published version: [CTAN](http://www.ctan.org/pkg/thuthesis) +* Developer version: [GitHub](https://github.com/xueruini/thuthesis) + +# Updates +## Automatic +Get the most up-to-date published version of the TeX tools from [CTAN](http://www.ctan.org/pkg/thuthesis). + +## Manual +Download the package from [GitHub](https://github.com/xueruini/thuthesis) to the root directory of your thesis, then execute the command (Windows users `Shift + right click` white area in the file window and click "Open command line window here from the popup menu"): + + xetex thuthesis.ins + +You'll get `thuthesis.cls` along with other template files. + +# Reporting Issues +Please follow the procedure below: + +* Check the [FAQ](https://github.com/xueruini/thuthesis/wiki/FAQ) +* [Github Issues](http://github.com/xueruini/thuthesis/issues) +* [TeX@newsmth](http://www.newsmth.net/nForum/#!board/TeX) +* [ThuThesis@Google Groups](http://groups.google.com/group/thuthesis) + +# Makefile Usage + +```shell +make [{all|thesis|shuji|doc|clean|cleanall|distclean}] +``` + +## Targets +* `make all` same as `make thesis && make shuji && make doc`; +* `make cls` generate template file; +* `make thesis` generate thesis main.pdf; +* `make shuji` generate book spine for printing shuji.pdf; +* `make doc` generate documentation thuthesis.pdf; +* `make clean` delete all examples' files (excluding main.pdf); +* `make cleanall` delete all examples' files and main.pdf; +* `make distclean` delete all examples' and templates' files and PDFs. |