diff options
Diffstat (limited to 'macros/unicodetex/latex/bithesis/README.md')
-rw-r--r-- | macros/unicodetex/latex/bithesis/README.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/macros/unicodetex/latex/bithesis/README.md b/macros/unicodetex/latex/bithesis/README.md new file mode 100644 index 0000000000..c76d91bfdc --- /dev/null +++ b/macros/unicodetex/latex/bithesis/README.md @@ -0,0 +1,43 @@ +<!-- This README aims to be packed into bithesis LaTeX package --> + +# The `bithesis` Class + +$\LaTeX$ thesis template for Beijing Institute of Technology. + +The current maintainer of this project is [Feng Kaiyu](https://github.com/fky2015). + +[![BIThesis](./assets/bithesis_badge_solid.svg)](https://bithesis.bitnp.net/) +[![Latexmk](https://badgen.net/badge/compiler/latexmk/blue)](https://mg.readthedocs.io/latexmk.html) +[![License](https://badgen.net/github/license/BITNP/BIThesis?color=008080&labelColor=2b2b2b)](./LICENSE) + +BIThesis is an unofficial LaTeX template set for your +**undergraduate, master or doctoral thesis** as well as other academic writing here at BIT. + +This project is supported by the _[Dept. of Undergraduate Academic Affairs, BIT](https://jwc.bit.edu.cn/)_ and the _[School of Computer Science and Technology, BIT](https://cs.bit.edu.cn/)_. See [Acknowledgements - Official Sponsors](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors). + +At present, `bithesis` only supports XeTeX and LuaTeX engines. `bithesis` only allows `UTF-8` encoding. + +## How Do I Use `bithesis`? + +### Installation + +``` +tlmgr install bithesis +``` + +Or make a clone from our [repo](https://github.com/BITNP/BIThesis). Then run: `make cls` to generate class files. + +## How Do I Use BIThesis? + +**For a comprehensive guide on how to install LaTeX, compile `bithesis`, and use a single one of BIThesis' template, please refer to BIThesis' Wiki. 👇** + +[![BIThesis Wiki](https://img.shields.io/badge/BIThesis-Wiki-009944?logo=wikipedia&labelColor=2b2b2b&style=for-the-badge)](https://bithesis.bitnp.net/) + +## Contributing + +For more details, please see the [contributing doc](./contributing.md). + +## Contributors + +For more information, please see: [Github Contributors](https://github.com/BITNP/BIThesis/graphs/contributors) and [Acknowledgements](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html). + |