From 67fec53d9d204ff43ce2759ec49d75eb3ba5062d Mon Sep 17 00:00:00 2001
From: Koyamin <koyafumin@gmail.com>
Date: Tue, 16 Apr 2024 15:26:59 +0800
Subject: [PATCH] Update README.md

---
 README.md | 52 +++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 35 insertions(+), 17 deletions(-)

diff --git a/README.md b/README.md
index 8b2d476..c0bbb4d 100644
--- a/README.md
+++ b/README.md
@@ -1,29 +1,47 @@
-# ECNUThesis-Undergraduate重构中
+# ECNUThesis-Undergraduate
 
-正在重构 ECNUThesis-Undergraduate 中。
+[![](https://img.shields.io/badge/Overleaf-ECNUthesis-brightgreen.svg)](https://www.overleaf.com/latex/templates/ecnuthesis-latex-thesis-template-for-east-china-normal-university/szppdtkvgvpk)
 
-## 模版构成
+## 华东师范大学本科生学士学位论文模版
 
-新的 ECNUThesis-Undergraduate 将由 `ecnuthesis.ins` 和 `ecnuthesis.dtx`
-构成。
+本模版使用 LaTeX3 重构了 [YijunYuan](https://github.com/YijunYuan) 的 [ECNU-Undergraduate-LaTeX](https://github.com/YijunYuan/ECNU-Undergraduate-LaTeX)，
+并将个人信息的填写、个性化设置、命令、环境等进行了一定的封装，让使用者可以更加方便地利用 LaTeX 进行创作。
 
-运行
-```shell
-xelatex "ecnuthesis.ins"
-```
-将根据 `ecnuthesis.dtx` 生成 `ecnuthesis.cls`。
+## 使用本模版
 
-运行
-```shell
-xelatex "ecnuthesis.dtx"
-```
-将生成模版文档。
+### 使用环境
 
-考虑未来关闭 [wiki](https://github.com/Koyamin/ECNUThesis-Undergraduate/wiki) 页面以优化文档维护工作。
+请安装最新的 TeX Live ，并使用 XeLaTeX 进行编译。
+
+若您的个人计算机中仍安装了老旧的 CTeX 套装，请毫不犹豫地卸载它，并安装最新版的 TeX Live。
+
+### 使用方法
+
+请移步 [Wiki](https://github.com/Koyamin/ECNUThesis-Undergraduate/wiki) 阅读相关文档。
+
+**注意**：为了保证正确的参考文献显示，请使用 `latexmk` 命令编译。具体方法详见 [编译](https://github.com/Koyamin/ECNUThesis-Undergraduate/wiki/使用模版编写论文#编译)。
+
+### 帮助
+
+若您在使用本模版的过程中有疑问，请先参考 [Wiki](https://github.com/Koyamin/ECNUThesis-Undergraduate/wiki) 中的 [常见问题](https://github.com/Koyamin/ECNUThesis-Undergraduate/wiki/常见问题)。若仍未能解决您的疑问，请移步 [Discussions](https://github.com/Koyamin/ECNUThesis-Undergraduate/discussions) 进行讨论。
+
+## 重要提醒
+
+1. 本模版**未经学校相关部门授权与审核**，使用前请务必**权衡风险**。任何因使用本模版而引起的**论文格式审查问题**均与本模版作者无关。
+2. 本模版仍在开发中，接口的稳定性无法保证。因此，在撰写论文的过程中，请慎重考虑是否需要同步更新模版。
+
+## 更新日志
+
+每个版本的详细更新日志见 [CHANGELOG.md](https://github.com/Koyamin/ECNUThesis-Undergraduate/blob/main/CHANGELOG.md)。
+
+## 贡献
+
+若您对本模版有改进意见或建议，欢迎您提交 [Issues](https://github.com/Koyamin/ECNUThesis-Undergraduate/issues) 以及 [Pull requests](https://github.com/Koyamin/ECNUThesis-Undergraduate/pulls)。
 
 ## 参考
 
 - Kunth D E. 的 The TeXBook: Computers & Typesetting.
+- Victor Eijkhout 的 [TEX BY TOPIC, A TEXNICIAN’S REFERENCE](https://ctan.org/pkg/texbytopic)
 - CTEX.ORG 的 CTeX 宏集手册
 - CTEX.ORG 的 xeCJK 宏包
 - The LaTeX3 Project 的 The LaTeX3 Sources
@@ -32,6 +50,6 @@ xelatex "ecnuthesis.dtx"
 
 ## 软件许可证
 
-华东师范大学校徽图案 (`inner-cover(contains_font).eps`) 版权归华东师范大学所有。
+华东师范大学校徽图案版权归华东师范大学所有。
 
 其他部分使用 LPPL 授权。