diff options
author | Norbert Preining <norbert@preining.info> | 2020-02-19 03:02:04 +0000 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2020-02-19 03:02:04 +0000 |
commit | c36a274c633c08115b6006622112f5609031001e (patch) | |
tree | e0935730aa90d6cd1427245dbb6e996fc331de94 /macros/latex/contrib/hitszthesis/README.md | |
parent | bb5325dae4202b519b7210a338651301e048998d (diff) |
CTAN sync 202002190302
Diffstat (limited to 'macros/latex/contrib/hitszthesis/README.md')
-rw-r--r-- | macros/latex/contrib/hitszthesis/README.md | 55 |
1 files changed, 41 insertions, 14 deletions
diff --git a/macros/latex/contrib/hitszthesis/README.md b/macros/latex/contrib/hitszthesis/README.md index 838f63a599..c915afa624 100644 --- a/macros/latex/contrib/hitszthesis/README.md +++ b/macros/latex/contrib/hitszthesis/README.md @@ -1,27 +1,54 @@ <!-- Author : Jingxuan Yang--> <!-- Program Email: yanglatex2e@gmail.com --> -[Github](https://github.com/YangLaTeX/YangThesis) | [Download](https://github.com/YangLaTeX/YangThesis/releases) | [Wiki](https://github.com/YangLaTeX/YangThesis/wiki) +[Github](https://github.com/YangLaTeX/YangThesis) | [Download](https://github.com/YangLaTeX/YangThesis/releases) | [Wiki](https://github.com/YangLaTeX/YangThesis/wiki) | [CTAN](https://www.ctan.org/pkg/hitszthesis) -# HITSZThesis +# Introduction to hitszthesis -## Introduction +HITSZThesis is a **bachelor dissertation** LaTeX template for **Harbin Institute of Technology, ShenZhen** (HITSZ). Current version is 2.0, updated on 2020/2/18. -HITSZThesis is a **bachelor dissertation** LaTeX template for **Harbin Institute of Technology, ShenZhen** (HITSZ). +# 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 (hitszthesis.pdf) +* Template example (main.pdf) -## Requirements +# Downloads +* Published version: [CTAN](https://www.ctan.org/pkg/hitszthesis) +* Developer version: [GitHub](https://github.com/YangLaTeX/hitszthesis) -This package uses `mtpro2` as math font, you can install this font from [here](https://www.latexstudio.net/archives/51742.html). +# Updates +## Automatic +Get the most up-to-date published version with your TeX distribution from [CTAN](https://www.ctan.org/pkg/hitszthesis). -## Version +## Manual +Download the package from [GitHub](https://github.com/YangLaTeX/hitszthesis) 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): -This is version 1.2, updated on 2/15/2020. +```shell +xetex hitszthesis.ins +``` -## Issues -If you have any questions or advice, you can create an issue at [https://github.com/YangLaTeX/YangThesis/issues](https://github.com/YangLaTeX/YangThesis/issues) +You'll get `hitszthesis.cls` along with other template files. -## Contact -Email: [yanglatex2e@gmail.com](mailto:yanglatex2e@gmail.com) +# Reporting Issues +Please follow the procedure below: -## License -This material is subject to the [LATEX Project Public License 1.3c](https://ctan.org/license/lppl1.3) or any later version.
\ No newline at end of file +* Check the [FAQ](https://github.com/YangLaTeX/hitszthesis/wiki/FAQ) +* [GitHub Issues](https://github.com/YangLaTeX/hitszthesis/issues) + +# Makefile Usage + +```shell +make [{all|thesis|spine|doc|clean|cleanall|distclean}] +``` + +## Targets +* `make thesis` generate thesis main.pdf; +* `make spine` generate book spine for printing spine.pdf; +* `make doc` generate template documentation hitszthesis.pdf; +* `make all` generate thesis and spine, same as `make thesis && make spine`; +* `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. + +# License +This material is subject to the [LATEX Project Public License 1.3c](https://ctan.org/license/lppl1.3) or any later version. |