Skip to content

README-bithesis.md

Latest commit

 

History

History
82 lines (50 loc) · 3.05 KB

README-bithesis.md

File metadata and controls

82 lines (50 loc) · 3.05 KB

The bithesis Class

$\LaTeX$ thesis template for Beijing Institute of Technology (BIT).

This project is maintained by BITNP (Net Pioneer Association of BIT), the de facto TUG at BIT. Maintainers are listed on the BIThesis website.

BIThesis Latexmk 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 and the School of Computer Science and Technology, BIT. See Acknowledgements - Official Sponsors.

At present, bithesis only supports XeTeX and LuaTeX engines. bithesis only allows UTF-8 encoding.

Installation

tlmgr install bithesis

How to use BIThesis?

For a comprehensive guide on how to install LaTeX, compile bithesis, and use BIThesis' templates, please refer to BIThesis' Wiki. 👇

BIThesis Wiki

How to build PDF documentations?

This section describes how to generate the following PDF documentations from bithesis-doc-src.zip manually.

  • Package documentation: bithesis.pdf
  • Quick start handbooks: bithesis-handbook-{undergraduate,graduate}.pdf

However, it is much easier to generate them by cloning our repo and running just doc handbooks. Details can be found in DEVELOPMENT.md there.

Package documentation

xetex bithesis.ins

7z x bithesis-doc-src.zip bithesis-pdf
mv bithesis-pdf/* .
rmdir bithesis-pdf

curl https://bithesis.bitnp.net/faq/index.tex -o assets/faq.tex

latexmk -xelatex -shell-escape bithesis.dtx  # `-shell-escape` is for lt3luabridge

Now check bithesis.pdf.

Quick start handbooks

  1. Generate bithesis.cls with xetex bithesis.ins or tlmgr install bithesis
  2. Run the following commands
7z x bithesis-doc-src.zip handbook
cd handbook

cp path/to/bithesis.cls .

latexmk
mv main.pdf bithesis-handbook-undergraduate.pdf

GRADUATE=true latexmk -gt  # `-gt` forces reprocessing *.tex files
mv main.pdf bithesis-handbook-graduate.pdf

Contributing

For more details, please see the contributing doc.

Contributors

For more information, please see: GitHub Contributors and Acknowledgements.