diff options
author | Karl Berry <karl@freefriends.org> | 2021-01-11 22:43:35 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2021-01-11 22:43:35 +0000 |
commit | 95014fe5a942b38f5bf44eeea7ea835bae53dd5e (patch) | |
tree | 926b1196163bb6c2d46cf2dbe4fb8a333014b645 /Master/texmf-dist/doc/latex/bithesis/README.md | |
parent | f018b40d7170d29f0ac3f0d053d988335a5423c7 (diff) |
bithesis (11jan21)
git-svn-id: svn://tug.org/texlive/trunk@57388 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/bithesis/README.md')
-rw-r--r-- | Master/texmf-dist/doc/latex/bithesis/README.md | 84 |
1 files changed, 40 insertions, 44 deletions
diff --git a/Master/texmf-dist/doc/latex/bithesis/README.md b/Master/texmf-dist/doc/latex/bithesis/README.md index a7cd83b2987..d8a8e199976 100644 --- a/Master/texmf-dist/doc/latex/bithesis/README.md +++ b/Master/texmf-dist/doc/latex/bithesis/README.md @@ -1,93 +1,89 @@ <div align="center"> - <img src="./assets/bithesis_icon.svg" alt="BIThesis Icon"> + <img src="assets/bithesis_icon.svg" alt="BIThesis Icon"> -📖 _非官方本科生毕业设计毕业论文 LaTeX 模板(以及更多)_ +📖 _Unofficial LaTeX templates for your bachelor graduation thesis (and maybe more)._ -![BIThesis](./assets/bithesis_badge_solid.svg) +[![BIThesis](./assets/bithesis_badge_solid.svg)](https://bithesis.bitnp.net/) +[![Chinese version](./assets/chinese.svg)](./README-zh.md) [![Latexmk](https://badgen.net/badge/compiler/Latexmk?color=blue&labelColor=2b2b2b)](https://mg.readthedocs.io/latexmk.html) [![License](https://badgen.net/github/license/BITNP/BIThesis?color=008080&labelColor=2b2b2b)](./LICENSE) [![Join on Slack](https://img.shields.io/badge/Slack%20Community-BIThesis-black?logo=slack&style=social&logoColor=2eb67d)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw) </div> -<h2>欢迎</h2> +<h2>Welcome</h2> -BIThesis 是针对北京理工大学本科同学毕业设计、毕业论文制作的一个非官方的 LaTeX 模板,BIThesis 同时也包括其他本科学习中涉及到的文献综述、实验报告等的 LaTeX 模板。 +BIThesis is an unofficial LaTeX template set for your **bachelor graduation thesis** and corresponding reports here at BIT. Hand-crafted following the specifications made by the _[Dept. of Undergraduate Academic Affairs](http://jwc.bit.edu.cn/)_ of _[Beijing Institute of Technology](http://http://www.bit.edu.cn/)_. -**我们正在对项目持续更新!目前,你完全可以使用现有的版本开始你的毕业设计开题报告的写作;不过与此同时,我们也在持续推进代码的升级和更新(主要是不影响使用的底层逻辑)。更多开发计划请访问我们的 [Roadmap](https://github.com/BITNP/BIThesis/projects)。想帮助这个项目持续前进?参见我们的[贡献者指南](./contributing-zh.md)。** +> This project is supported by the _[Dept. of Undergraduate Academic Affairs, BIT](http://jwc.bit.edu.cn/)_ and the _[School of Computer Science and Technology, BIT](http://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). -> 本项目获得了 [北京理工大学教务部](http://jwc.bit.edu.cn/)、[北京理工大学计算机学院](http://cs.bit.edu.cn/) 的认可、背书与大力支持。详见:[致谢 - 官方赞助](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html#%E5%AE%98%E6%96%B9%E8%B5%9E%E5%8A%A9-official-sponsors)。 +<h2>Slack Community</h2> -<h2>Slack 社区</h2> - -> 订阅更新,询问问题,提出需求……来参加 Slack 上面的北理 BIThesis 官方社区! +> Subscribe to new releases, ask questions, request features, etc. Come join our official community on Slack! [![Join on Slack](./assets/slack.svg)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw) -<h2>内容</h2> +<h2>Table of Contents</h2> -- [开发者指南](#开发者指南) -- [贡献者指南](#%e8%b4%a1%e7%8c%ae%e8%80%85%e6%8c%87%e5%8d%97) -- [贡献者](#%e8%b4%a1%e7%8c%ae%e8%80%85) -- [相关项目](#%e7%9b%b8%e5%85%b3%e9%a1%b9%e7%9b%ae) -- [发布状态](#%e5%8f%91%e5%b8%83%e7%8a%b6%e6%80%81) +- [How do I use BIThesis?](#how-do-i-use-bithesis) + - [Detailed online Wiki](#detailed-online-wiki) + - [PDF handbook](#pdf-handbook) + - [Online Video Tutorials](#online-video-tutorials) +- [Contributing](#contributing) +- [Contributors](#contributors) +- [Similar Projects](#similar-projects) +- [Release status](#release-status) +## How do I use BIThesis? +### Detailed online Wiki -## 开发者指南 +**For a comprehensive guide on how to install LaTeX, compile BIThesis, and use a single one of BIThesis' template, please refer to BIThesis' Wiki. 👇** -### 生成 .cls 文件 +[![BIThesis Wiki](https://img.shields.io/badge/BIThesis-Wiki-009944?logo=wikipedia&labelColor=2b2b2b&style=for-the-badge)](https://bithesis.bitnp.net/) -```Bash -make cls -``` +Specifically, detailed guides on how to use a single one of the templates are available at: -### 生成宏包手册 +- [BIThesis Wiki: Proposal report](https://bithesis.bitnp.net/Guide/3-Templates/Proposal-Report.html) +- [BIThesis Wiki: Graduation thesis](https://bithesis.bitnp.net/Guide/3-Templates/Final-Graduation-Thesis.html) +- [BIThesis Wiki: Lab report](https://bithesis.bitnp.net/Guide/3-Templates/Lab-Report.html) -```Bash -make doc -``` +### PDF handbook -### 与 scaffold 联调开发 +We also provide a PDF handbook on how to use BIThesis. You can download the PDF version of the BIThesis handbook here: [`bithesis-documentation.pdf`](https://github.com/BITNP/BIThesis/releases/latest). -将 `BITNP/BIThesis` 与 `BITNP/BIThesis-scaffold` 放在同一级目录下, -然后进入 `BIThesis` 目录。 +### Online Video Tutorials -```Bash -# 请首先确保 entr 正确安装 -ls bithesis.dtx | entr -s 'yes -y y | make doc && make copy' -``` +You can watch online video tutorials here: -## 贡献者指南 +- Bilibili: [BIThesis —— 教你优雅地撰写论文 | LaTeX 毕设模板系列教程](https://www.bilibili.com/video/BV1GT4y1V78d/) +- BIThesis documentation videos (including some code which are referenced in the videos): [BIThesis - Videos](https://bithesis.bitnp.net/Video/) -详情请查看[贡献者指南](./contributing-zh.md)。 +## Contributing -## 贡献者 +For details, please see the [contributing doc](./contributing.md). -> 本项目的存在离不开以下所有贡献者的辛勤贡献。更多信息请访问:[BIThesis - 致谢](https://bithesis.bitnp.net/Guide/5-Acknowledgements/Acknowledgements.html)。 +## Contributors -[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/0)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/0)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/1)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/1)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/2)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/2)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/3)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/3)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/4)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/4)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/5)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/5)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/6)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/6)[![](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/images/7)](https://sourcerer.io/fame/spencerwooo/spencerwooo/BIThesis/links/7) +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). -## 相关项目 +## Similar Projects - [北京理工大学硕士(博士)学位论文 LaTeX 模板](https://github.com/BIT-thesis/LaTeX-template) - [fduthesis(复旦大学论文模板)](https://github.com/stone-zeng/fduthesis) - [上海交通大学 XeLaTeX 学位论文及课程论文模板](https://github.com/sjtug/SJTUThesis) - …… -## 发布状态 +## Release status | CI | Build status | | :------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| GitHub Release | ![GitHub Release](https://github.com/BITNP/BIThesis/workflows/Release/badge.svg?branch=master) | +| GitHub Release | ![GitHub Release](https://github.com/BITNP/BIThesis/workflows/Release/badge.svg?branch=master) | | Netlify Deploy | [![Netlify Status](https://api.netlify.com/api/v1/badges/81f7b49b-59a1-46bc-ba52-02f8be71d247/deploy-status)](https://app.netlify.com/sites/vigorous-hoover-a697eb/deploys) | -<!-- ## 免责声明 - -本项目尚未经由 _北京理工大学教务部_ 确认(但即将会被官方授权)。使用此模板的风险由你自己承担。笔芯 (´▽`ʃ♡ƪ) --> --- -📖 **BIThesis** ©BITNP/BIThesis. Released under the [LaTeX Project Public License](LICENSE). +📖 **BIThesis** ©Spencer Woo. Released under the [LaTeX Project Public License](LICENSE). Authored by Spencer Woo. Maintained with help from [contributors](https://github.com/BITNP/BIThesis/graphs/contributors). |