aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--README.md2
-rw-r--r--docs/source/quick-start.md55
2 files changed, 56 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6de51af7..b17ab2c8 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
Infini 2 是一个先进的内容输入输出流标准框架,它的诞生源于对于平台机器人的代码复用问题,以及指令的动态解析问题。Infini 2 的规则包是可热插拔的,它以使用 Infini 框架的规则包为最小热插拔单元,以`输入→预拦截→业务函数→内容生成→内容拦截→输出`为一整套 Infini 输入输出流程式,规则包可以定制化的注册任一流程层次的处理函数。
-Infini 2 同样是**跨平台跨框架**的。你可以在任何支持 Python 的平台运行 Infini,同样的,你在对接平台时,可以选用任何框架来适配 Infini 2,例如[`Nonebot2`](https://github.com/nonebot/nonebot2)、[`Avilla`](https://github.com/GraiaProject/Avilla)和[`iamai`](https://github.com/retrofor/iamai/)等,而这些框架都是跨平台和跨协议的,这意味着 Infini 2 同样是跨平台和跨协议支持的。Infini 可能将在未来版本支持直接对接平台协议。
+Infini 2 同样是**跨平台跨框架**的。你可以在任何支持 Python 的平台运行 Infini,同样的,你在对接平台时,可以选用任何框架来适配 Infini 2,例如[`Nonebot2`](https://nonebot.dev/)、[`OlivOS`](https://doc.olivos.wiki/)和[`iamai`](https://github.com/retrofor/iamai/)等,而这些框架都是跨平台和跨协议的,这意味着 Infini 2 同样是跨平台和跨协议支持的。Infini 可能将在未来版本支持直接对接平台协议。
Infini 2 所有层次的业务函数都是依照参数名进行**依赖注入**的,你可以动态的选择你所需要的注入参数。由于先进的架构特性,Infini 2 可以省去大量的开发时间,节约开发成本。同时由于其轻量的输入输出流程式,它拥有较低的学习成本。
diff --git a/docs/source/quick-start.md b/docs/source/quick-start.md
index bb1a5a95..7f08e0f6 100644
--- a/docs/source/quick-start.md
+++ b/docs/source/quick-start.md
@@ -21,3 +21,58 @@
### Infini 包管理器
我们强烈推荐使用 Infini 包管理器——**IPM**来构建一个 Python 规则包。
+
+你可以通过执行终端指令来安装 IPM:
+
+```bash
+pip install ipdm
+```
+
+安装完成后,在终端中执行`ipm`确保 IPM 被正确安装。
+
+## 创建项目
+
+1. 使用 IPM 创建规则包
+
+ 你可以使用以下指令创建 Infini 规则包:
+
+ ```bash
+ ipm new yourpackage
+ ```
+
+ IPM 将为你初始化一个 Infini 规则包,你应该将`yourpackage`替换为你的包名。
+
+ 也可以在已有的文件夹内创建:
+
+ ```bash
+ cd exists_directory
+ ipm init
+ ```
+
+ 这两者是等效的。
+
+ 你可以前往[IPM 文档](https://ipm.hydroroll.team/)获得更多关于 IPM 使用的信息。
+
+2. 手动创建规则包
+
+ 首先在一个目录中创建`infini.toml`,并写入以下内容:
+
+ ```toml
+ [infini]
+ name = "yourpackage"
+ version = "0.1.0"
+ description = "规则包描述"
+ license = "AGPLv3"
+
+ [requirements]
+
+ [dependencies]
+ ```
+
+ 然后在同一个目录创建一个`src`文件夹,并在`src`中建立一个入口文件(`__init__.py`或`yourpackage.py`,这两者是等效的)。
+
+## 正式开始
+
+以上你已经成功建立了 Infini 开发环境,现在你可以开始学习如何构建一个你自己的规则包了。
+
+Infini 2 规则包应当遵循规定的规则包标准,你可以前往阅读[通用规则包标准文档](grps/index)来进行下一步的学习。