Skip to content

Commit

Permalink
Update readme and version
Browse files Browse the repository at this point in the history
- Update readme.
- Prepare version v0.1.1.
  • Loading branch information
TheNetAdmin committed Apr 26, 2018
1 parent 56ff5c9 commit d2a79f5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# ZJUTHESIS
# 浙江大学毕业设计/论文模板

![ZJUTHESIS](https://img.shields.io/badge/ZJUTHESIS-Template-blue.svg)

## 简介

本项目为浙江大学本科生毕业设计/论文的LaTeX模板,来源于作者自行编写的计算机学院毕业设计模板。本模板依据2018年`浙江大学本科生毕业论文(设计)编写规则`编写了[通用格式](config/format/general/format.tex)并根据2018年`浙江大学计算机学院毕业设计开题报告模板`编写了[计算机科学与技术专业专用格式](config/format/major/cs/format.tex)
本项目为浙江大学本科生毕业设计/论文的LaTeX模板,来源于作者自行编写的计算机学院毕业设计模板。本模板依据2018年[浙江大学本科生毕业论文(设计)编写规则](http://bksy.zju.edu.cn/attachments/2018-01/01-1517384518-1149149.pdf)编写了[通用格式](config/format/general/format.tex)并根据[2018年浙江大学计算机学院本科生毕业论文(设计)文件和开题报告模板3](http://cspo.zju.edu.cn/cspo_bks/content.php?id=8640)编写了[计算机科学与技术专业专用格式](config/format/major/cs/format.tex)

## 使用

1. 安装TexLive工具包,编译需要XeLatex引擎
2. download/clone本代码仓库
1. 安装TexLive工具包,编译需要XeLaTeX引擎
2. [下载](https://github.com/TheNetAdmin/zjuthesis/releases)或clone此模板
3.`content`目录下编写内容
3.`figure`目录下保存图片,在`reference/ref.bib`内插入文献条目
5. 在根目录下运行命令`latexmk -xelatex -outdir=out zjutheis`即可编译LaTex到`out`目录(该目录不会被记录版本)
Expand All @@ -24,11 +24,12 @@

1. 为何不使用`.cls`:我个人认为将所有格式写入同一文件会造成扩展与修改的困难,面对一个.cls中几百行上千行的代码,即使有注释也很难进行正确的修改和扩展。所以我将所有格式以及命令定义都放入`config`文件夹内,并以文件名区分其负责的格式内容。虽然这样带来了大量的文件引入,但相对来讲更易于定位代码和进行扩展
2. 为何只有开题报告模板:编写此模板时,计算机学院只发布了开题报告模板,无法编写后续模板,故[当前模板版本号](config/version.tex)定为`0.*.*`。待后续模板编写完成后会发布`1.*.*`版本
3. 为何只有计算机科学与技术专业模板:由于个人精力有限,难以编写完全,如果其他专业同学有相关需求,可以:
3. 为何当前版本与上一版本不兼容:由于现在的模板还处在开发期,难免有一些不向后兼容的修改,等发布正式版(版本号 >= `1.*.*`)后,会持续发布向后兼容的模板
4. 为何只有计算机科学与技术专业模板:由于个人精力有限,难以编写完全,如果其他专业同学有相关需求,可以:
- 在Github上提出issue,附上模板格式要求
- 发送邮件到我邮箱(zxwang42 [at] gmail [dot] com),附上模板格式要求与样例文件
- **在Github上提出Pull Request,贡献你编写的代码**
4. 其他问题请在Github issue提出或使用邮件与我联系
5. 其他问题请在Github issue提出或使用邮件与我联系

## 开源许可

Expand Down
2 changes: 1 addition & 1 deletion config/version.tex
Original file line number Diff line number Diff line change
@@ -1 +1 @@
\newcommand{\zjuthesisversion}{0.1.0}
\newcommand{\zjuthesisversion}{0.1.1}

0 comments on commit d2a79f5

Please sign in to comment.