From 956e7e7e98778993131fe5c03578ae46800dd2a3 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Sat, 7 Oct 2023 02:58:53 +0800 Subject: chore: update readme --- README.md | 9 +++++---- pyproject.toml | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f5538c25..e18e47bb 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ ``` shell git clone https://github.com/HydroRoll-Team/HydroRollCore.git cd HydroRollCore -poetry install --no-dev +pdm install # 或者使用pip # pip install HydroRollCore ``` @@ -35,15 +35,16 @@ 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): +class Myrule(Rule): """自设规则包,继承 Rules 基类""" ``` diff --git a/pyproject.toml b/pyproject.toml index 2b6ae02c..f73edbbb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "HydroRollCore" -version = "0.1.0" +version = "0.1.0-rc1" description = "The Core of HydroRoll, The Loader of your rules packages." authors = [ {name = "简律纯", email = "i@jyunko.cn"}, -- cgit v1.2.3-70-g09d2