diff options
Diffstat (limited to 'docs/source/quick-start.md')
| -rw-r--r-- | docs/source/quick-start.md | 55 |
1 files changed, 55 insertions, 0 deletions
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)来进行下一步的学习。 |
