summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/hitszthesis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/hitszthesis/README.md')
-rw-r--r--macros/latex/contrib/hitszthesis/README.md24
1 files changed, 20 insertions, 4 deletions
diff --git a/macros/latex/contrib/hitszthesis/README.md b/macros/latex/contrib/hitszthesis/README.md
index c915afa624..69d04a94f3 100644
--- a/macros/latex/contrib/hitszthesis/README.md
+++ b/macros/latex/contrib/hitszthesis/README.md
@@ -1,14 +1,14 @@
<!-- 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)
+[Github](https://github.com/YangLaTeX/hitszthesis) | [Download](https://github.com/YangLaTeX/hitszthesis/releases) | [Wiki](https://github.com/YangLaTeX/hitszthesis/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.
+HITSZThesis is a **bachelor dissertation** LaTeX template for **Harbin Institute of Technology, ShenZhen** (HITSZ). Current version is 2.1, updated on 2020/2/23.
# 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>:
+Download and unzip the template. Specific usage documentation and examples can be found in the files below. At present, these documents are **only available in Chinese**:
* Template usage (hitszthesis.pdf)
* Template example (main.pdf)
@@ -17,6 +17,7 @@ Download and unzip the template. Specific usage documentation and examples can b
* 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).
@@ -32,6 +33,7 @@ You'll get `hitszthesis.cls` along with other template files.
# Reporting Issues
Please follow the procedure below:
+* QQ group: 1039392552
* Check the [FAQ](https://github.com/YangLaTeX/hitszthesis/wiki/FAQ)
* [GitHub Issues](https://github.com/YangLaTeX/hitszthesis/issues)
@@ -46,9 +48,23 @@ make [{all|thesis|spine|doc|clean|cleanall|distclean}]
* `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 wordcount` count word in thesis main.pdf
* `make clean` delete all examples' files (excluding main.pdf);
-* `make cleanall` delete all examples' files and main.pdf;
+* `make cleanall` delete all examples' files and all pdf file;
* `make distclean` delete all examples' and templates' files and PDFs.
+# Compile.bat Usage
+
+```bash
+Compile.bat cls # generate class hitszthesis.cls
+Compile.bat doc # generate template documentation hitszthesis.pdf
+Compile.bat thesis # generate thesis main.pdf
+Compile.bat spine # generate book spine for printing spine.pdf
+Compile.bat all # generate thesis and spine, same as `make thesis && make spine`
+Compile.bat wordcount # count word in thesis main.pdf
+Compile.bat clean # delete all examples' files (excluding main.pdf)
+Compile.bat cleanall # delete all examples' files and all pdf file
+```
+
# License
This material is subject to the [LATEX Project Public License 1.3c](https://ctan.org/license/lppl1.3) or any later version.