summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/cquthesis/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/cquthesis/README.md')
-rw-r--r--macros/latex/contrib/cquthesis/README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/macros/latex/contrib/cquthesis/README.md b/macros/latex/contrib/cquthesis/README.md
new file mode 100644
index 0000000000..bfa0213a6a
--- /dev/null
+++ b/macros/latex/contrib/cquthesis/README.md
@@ -0,0 +1,52 @@
+# About CQUThesis
+[![CI Building State](https://api.travis-ci.org/nanmu42/CQUThesis.svg?branch=master)](https://travis-ci.org/nanmu42/CQUThesis)
+[![CTAN release](https://img.shields.io/ctan/v/cquthesis.svg?label=CTAN)](https://www.ctan.org/pkg/cquthesis)
+[![GitHub release](https://img.shields.io/github/release/nanmu42/cquthesis.svg?label=Github)](https://github.com/nanmu42/CQUThesis/releases/latest)
+[![GitHub commits](https://img.shields.io/github/commits-since/nanmu42/CQUThesis/v1.40.svg)](https://github.com/nanmu42/CQUThesis/commits/master)
+[![DOI](https://zenodo.org/badge/58866503.svg)](https://zenodo.org/badge/latestdoi/58866503)
+
+**CQUThesis** stands for Chongqing University Thesis Template for LaTeX, bearing the ability to support bachelor, master, doctor dissertations with grace and speed.
+
+![CQUThesis-Poster](https://cloud.githubusercontent.com/assets/8143068/15363773/68c6b380-1d4c-11e6-9627-4d892facb333.png)
+
+# Deployment
+## Download
+Version | Link | Description
+--- | --- | ---
+Dev. |[Click Here](https://github.com/nanmu42/cquthesis/zipball/master) | Recommend with new features and bug fixes
+Pre-release | [Github Link](https://github.com/nanmu42/CQUThesis/releases) | Accumulation of commits from Dev.
+Release |[CTAN Page](https://www.ctan.org/pkg/cquthesis)| Scheduled updates for CTAN, MikTeX and TeX Live
+
+## Installation
+Unzip all files to a new folder as your future work folder:
+* Windows users may easily double-click on `makewin.bat`;
+* Linux or Mac users may start the terminal:
+```
+cd path/to/cquthesis
+make thesis
+```
+If everything goes smoothly, CQUThesis is ready for work, with typeseting example named `main.pdf` in your work folder.
+
+# Question, Contribution and Contact
+Feel free to raise any question, and any possible contribution is highly appreciated.
+* [Github Issues](https://github.com/nanmu42/CQUThesis/issues);
+* Join [CQU TeX QQ Group](http://jq.qq.com/?_wv=1027&k=2HvYu95)
+
+Writing in English or Chinese is needed.
+
+# Acknowledgements
+The author would like to acknowledge these contributors for their efforts and, essentially, beautiful mind:
+
+* [The CTeX Community](https://github.com/CTeX-org/ctex-kit)
+* [XUE, Ruini](https://github.com/xueruini/thuthesis)
+* [USTC TeX User Group](https://github.com/ustctug/gbt-7714-2015)
+
+# About the Author
+Zhennan Li (i at nanmu dot me) proudly presents this work for you.
+
+# License
+This whole project may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.3 of this license or (at your option) any later version. The latest version of this license is in:
+
+http://www.latex-project.org/lppl.txt
+
+and version 1.3 or later is part of all distributions of LaTeX version 2005/12/01 or later.