diff options
Diffstat (limited to 'Master/texmf-dist/doc/latex/hitszthesis/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/hitszthesis/README.md | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/hitszthesis/README.md b/Master/texmf-dist/doc/latex/hitszthesis/README.md new file mode 100644 index 00000000000..c915afa6243 --- /dev/null +++ b/Master/texmf-dist/doc/latex/hitszthesis/README.md @@ -0,0 +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) | [CTAN](https://www.ctan.org/pkg/hitszthesis) + +# Introduction to hitszthesis + +HITSZThesis is a **bachelor dissertation** LaTeX template for **Harbin Institute of Technology, ShenZhen** (HITSZ). Current version is 2.0, updated on 2020/2/18. + +# 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) + +# Downloads +* Published version: [CTAN](https://www.ctan.org/pkg/hitszthesis) +* Developer version: [GitHub](https://github.com/YangLaTeX/hitszthesis) + +# Updates +## Automatic +Get the most up-to-date published version with your TeX distribution from [CTAN](https://www.ctan.org/pkg/hitszthesis). + +## 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): + +```shell +xetex hitszthesis.ins +``` + +You'll get `hitszthesis.cls` along with other template files. + +# Reporting Issues +Please follow the procedure below: + +* 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. |