perf: 更新README

This commit is contained in:
RockChinQ
2024-08-30 10:42:43 +08:00
parent 459f8b1c43
commit ef2c5db6be
+2 -10
View File
@@ -35,19 +35,11 @@ npm run docs:dev
### 部署细节
现在使用 Cloudflare Pages 托管,提交后自动部署。
### 推荐环境
推荐使用 GitHub Codespaces 编写,仓库页面点击 "Code" -> "Codespaces" -> 直接创建一个 Codespace
在其中按照上述方式安装依赖并运行调试。
> 若出现`Error: /lib/x86_64-linux-gnu/libstdc++.so.6: version GLIBCXX_3.4.29`的报错,请按照如下文章内容解决:
> https://zhuanlan.zhihu.com/p/615111375
现在使用 Cloudflare Pages 托管,提交后 @RockChinQ 更新分支进行自动部署。
### 一些规范化标准
- 文件夹和文件的命名:**一律使用全小写,单词直接`-`隔开,如**`plugin-intro.md`
- 子文件(夹)的命名,**不加前缀**(即文件夹的名称),如:`deploy`文件夹下的,文件夹`qchatgpt`,`qchatgpt`文件夹下的`manual`文件称之为`manual.md`
- 由于这是有关于文档的规范化命名,所以任何文件的名称都可以以教程的角度来理解,如`deploy`是有关部署的教程
- 除了配置文件板块的文档,其他的页面都不要在顶部加目录