From 8d82bd888736ca9b700fbcbdd86b44ccf1cd061d Mon Sep 17 00:00:00 2001
From: Junyan Qin <1010553892@qq.com>
Date: Wed, 20 Dec 2023 02:59:38 +0000
Subject: [PATCH] =?UTF-8?q?doc:=20=E6=B7=BB=E5=8A=A0=20READMD.md?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 29 ++++++++++++++++++++++++++---
 1 file changed, 26 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 24b81e440..d88e1e086 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,26 @@
-## 本项目为QChatGPT官方文档，欢迎各路人士完善
-[QChatGPT项目地址](https://github.com/RockChinQ/QChatGPT)
-[本文档地址](https://qchatgpt.rockchin.top)
+# [QChatGPT](https://github.com/RockChinQ/QChatGPT) 官方文档
+
+> [QChatGPT 代码仓库](https://github.com/RockChinQ/QChatGPT)   
+> [本文档地址](https://qchatgpt.rockchin.top)
+
+## 参与编写
+
+文档基于 VuePress 生成，本地编写需要安装 Node 和 VuePress
+
+### NodeJS
+
+自行安装
+
+### VuePress 
+
+Clone 本仓库，在目录下执行以下命令安装依赖：
+
+```bash
+yarn install
+```
+
+完成后即可修改文档，修改完后使用以下命令本地启动：
+
+```bash
+yarn docs:dev
+```