doc: 添加 READMD.md

This commit is contained in:
Junyan Qin
2023-12-20 02:59:38 +00:00
parent a6f38bfd8c
commit 8d82bd8887
+26 -3
View File
@@ -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
```