From b4af6df772f28ae756455b6b8a19b22f240b1e2e Mon Sep 17 00:00:00 2001 From: crazywhalecc Date: Thu, 5 Jan 2023 10:43:44 +0800 Subject: [PATCH] update docs --- docs/guide/README.md | 1 + docs/guide/configuration.md | 4 ++-- docs/guide/get_started.md | 2 +- docs/guide/installation.md | 4 ++++ 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/guide/README.md b/docs/guide/README.md index 63b497c9..995c6684 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -24,3 +24,4 @@ - 支持多个机器人账号负载均衡 - 完善的插件系统，可以随意加载和编写独立的插件 - 灵活的注释和注解注册事件方式，支持 PHP 原生注解，提示更为友好 +- 如果你不想安装 PHP 环境，可以使用静态编译的 PHP diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md index e5262468..9029339f 100644 --- a/docs/guide/configuration.md +++ b/docs/guide/configuration.md @@ -1,6 +1,6 @@ # 配置 -炸毛框架的所有配置文件都存储在 `config` 目录中。每个选项都带有文档，所以你可以查阅这些文件并熟悉可用的配置项。 +炸毛框架的所有配置文件都存储在 `config/` 目录中。每个选项都带有文档，所以你可以查阅这些文件并熟悉可用的配置项。 一般来说，我们建议你优先查看 `config/global.php` 文件及其文档，它包含了运行框架所需要的绝大部分配置，例如通信方式和时区等。 @@ -32,7 +32,7 @@ ## 访问配置项 -你可以在任何地方使用全局 `config` 函数获取配置项值。支持使用点语法获取，配置项名称由文件名开头，并允许指定默认值。 +你可以在任何地方使用全局 `config()` 函数获取配置项值。支持使用点语法获取，配置项名称由文件名开头，并允许指定默认值。 ```php # 获取时区，未设置则返回 Asia/Shanghai diff --git a/docs/guide/get_started.md b/docs/guide/get_started.md index 65f85b55..ef922064 100644 --- a/docs/guide/get_started.md +++ b/docs/guide/get_started.md @@ -6,7 +6,7 @@ 其中一些可用的选项为： -- Walle-Q +- Walle-Q（QQ 端） - 更多… ## 机器人实现端 diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 83b6ea29..8907858b 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -83,6 +83,10 @@ cd zhamao-v3 7. 接下来你就可以使用和上方所有框架操作指令相同的内容了，例如 `./zhamao plugin:make`、`./zhamao server` 等。 8. 如果你需要使用 Composer，你可以使用 `.\runtime\php\php.exe .\runtime\composer.phar` 来代替 `composer` 命令。 +## 提升性能 + +如果你打算让你的框架提升处理性能，我们建议你为 PHP 安装 Swoole 扩展、libevent 扩展，或将 PHP 版本提升到 8.1 及以上。 + ## 更多的环境部署和开发方式 除了上述方式之外，框架还支持源码模式、守护进程等运行方式，详情请参阅 [进阶开发]。