From 4b174b5b5646f748a9cd1bba33c7e4f9b247eecb Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Sat, 7 Oct 2023 07:49:33 +0800 Subject: feat(docs): version update --- docs/Core/index.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) (limited to 'docs/Core') diff --git a/docs/Core/index.md b/docs/Core/index.md index 3f3422b6..aff4930b 100644 --- a/docs/Core/index.md +++ b/docs/Core/index.md @@ -21,7 +21,7 @@ ``` shell git clone https://github.com/HydroRoll-Team/HydroRollCore.git cd HydroRollCore -poetry install --no-dev +pdm install # 或者使用pip # pip install HydroRollCore ``` @@ -30,16 +30,17 @@ poetry install --no-dev ``` shell mkdir myrules && cd myrules && mkdir rule1 -echo.> config.toml && echo.> __init__.py :: 创建空的配置文件和python运行脚本 +echo.> config.toml +echo.> __init__.py ``` 在 `__init__.py` 创建一个 `rule` 实例并继承 `Rule` 基类, 通过编写合适的相关方法与类注册规则包实现规则的自定义。 ``` python -from HydroRollCore import Rules +from HydroRollCore import Rule -class Myrule(Rules): - """自设规则包,继承 Rules 基类""" +class Myrule(Rule): + """自设规则包,继承 Rule 基类""" ``` 3. 合理修改你的 `config.toml` 配置文件,完成注册! -- cgit v1.2.3-70-g09d2