chore(merging): 'docs-readme-rewrite' into 'main'

docs(README):  更新文档

See merge request sysu-gitlab/thesis-template/better-thesis!23

Makefile

@@ -1,7 +1,8 @@
+TYPST_FLAGS += --root .
 TYPST_FLAGS += --font-path fonts
 
 thesis:
-	typst compile ${TYPST_FLAGS} thesis.typ
+	typst compile ${TYPST_FLAGS} thesis.typ thesis.pdf
 
 watch:
-	typst watch ${TYPST_FLAGS} thesis.typ
+	typst watch ${TYPST_FLAGS} thesis.typ thesis.pdf

README.md

@@ -1,18 +1,20 @@
 # 基于 Typst 的中山大学学位论文模板
-[![GitLab 仓库](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis/-/badges/release.svg?style=flat-square&value_width=100)](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis) [![GitHub stars](https://img.shields.io/github/stars/sysu/better-thesis.svg?style=social&label=Star&maxAge=2592000)](https://github.com/sysu/better-thesis)
+[![GitLab 仓库](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis/-/badges/release.svg?style=flat-square&value_width=100)](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis/-/releases) [![GitHub stars](https://img.shields.io/github/stars/sysu/better-thesis.svg?style=social&label=Star&maxAge=2592000)](https://github.com/sysu/better-thesis)
 
-当前还未完全符合学位论文格式要求，欢迎同学/校友们[贡献代码](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis/-/merge_requests/new)/反馈问题（[GitLab issue](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis/-/issues/new)/[邮件](mailto:contact-project+sysu-gitlab-thesis-template-better-thesis-57823416-issue-@incoming.gitlab.com)）！模板交流 QQ 群：[797942860](https://jq.qq.com/?_wv=1027&k=m58va1kd)
+**[点击此处注册 typst.app 并创建你的论文工程](https://typst.app/app?template=modern-sysu-thesis&version=0.1.1)**
+
+当前还未完全符合学位论文格式要求，欢迎同学/校友们[贡献代码](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis/-/merge_requests)/反馈问题（[GitLab issue](https://gitlab.com/sysu-gitlab/thesis-template/better-thesis/-/issues)/[邮件](mailto:contact-project+sysu-gitlab-thesis-template-better-thesis-57823416-issue-@incoming.gitlab.com)）！模板交流 QQ 群：[797942860](https://jq.qq.com/?_wv=1027&k=m58va1kd)
 
 **Q：我不会 LaTeX，可以用这个模板写论文吗？**
 
 **A：完全可以！Typst 是一个比 LaTeX 更简单的排版语言，同时安装更加方便，编译更加快速！**
 
 ## 使用方法
 
-**由于 Typst 还处于初期的快速开发阶段，本项目需要使用从源码编译的 Typst 版本才能正常生成 PDF。仓库提供了一键安装脚本，按照使用说明运行即可。**
+### typst.app
+经过近一月紧张的迭代重构，本模板已经[发布在typst.universe](https://typst.app/universe/package/modern-sysu-thesis)上，[点击此处直接创建你的论文工程](https://typst.app/app?template=modern-sysu-thesis&version=0.1.1)，并直接开始编写你的论文！
 
-<!-- TODO: 提供 typst.universe 版本 -->
-<!-- TODO: 在 typst.universe 版本上线后分离模板项目 -->
+<!-- TODO(#1): 在 typst.universe 版本上线后分离模板项目 -->
 
 ### Windows 用户
 
@@ -42,7 +44,7 @@ replace-with = "tuna"
 [source.tuna]
 registry = "https://mirrors.tuna.tsinghua.edu.cn/git/crates.io-index.git"
 EOF
-cargo install --git https://ghproxy.com/https://github.com/typst/typst.git
+cargo install typst-cli
 ```
 
 3. 根据 [Typst 文档](https://typst.app/docs/)，参考 [项目结构](#项目结构) 中的说明，按照你的需要修改论文的各个部分。

cliff.toml

@@ -63,7 +63,7 @@ commit_parsers = [
   { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
   { message = "^style", group = "<!-- 5 -->🎨 Styling" },
   { message = "^test", group = "<!-- 6 -->🧪 Testing" },
-  { message = "^chore\\(release\\):prepare for", skip = true },
+  { message = "^chore\\(release\\):\\s?prepare for", skip = true },
   { message = "^chore\\(deps.*\\)", skip = true },
   { message = "^chore\\(merging\\)", skip = true },
   { message = "^chore\\(pull\\)", skip = true },

compile.bat

@@ -2,6 +2,6 @@
 chcp 65001>nul
 set TYPST_FONT_PATHS=%cd%\fonts
 echo 编译中……
-typst compile --root=%cd% --font-path=fonts template/thesis.typ
+typst compile --root=%cd% --font-path=fonts template/thesis.typ %cd%/thesis.pdf
 echo 命令运行完毕，按任意键退出
 pause>nul