From f3d526ef80a5e49d2219e5bc4db368451acc18da Mon Sep 17 00:00:00 2001
From: vonbrank <vonbrank@outlook.com>
Date: Thu, 18 May 2023 01:35:16 +0800
Subject: [PATCH] docs: update README

---
 README.md | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index df35eef..c4d1384 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,13 @@
 # HIT-Thesis-Typst
-哈尔滨工业大学 Typst 论文模板
+
+适用于哈尔滨工业大学学位论文的 Typst 模板
+
+## ⚠️ 警告
+
+本模板正处于积极开发阶段，适合尝鲜 Typst 特性，暂不适用于正式的论文写作
+
+## 关于本项目
+
+[Typst](https://typst.app/) 是使用 Rust 实现的全新文档排版系统，有望以 Markdown 级别的简洁语法和编译速度实现 LaTeX 级别的排版能力，即通过编写遵循 Typst 语法规则的文本文档，执行编译命令，来可生成目标格式的 PDF 文档。
+
+**HIT Thesis Typst** 是一套简单易用的哈尔滨工业大学学位论文 Typst 模板，受 [hithesis](https://github.com/hithesis/hithesis) 启发，计划囊括一校三区本科、硕士、博士的学位论文格式。