From dfa4989a90e3631b7757639d4dccf84fa9ee029c Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 6 Oct 2023 22:59:21 +0000 Subject: Deployed 77edb63 to dev with MkDocs 1.5.3 and mike 1.1.2 --- dev/Core/index.html | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 dev/Core/index.html (limited to 'dev/Core') diff --git a/dev/Core/index.html b/dev/Core/index.html new file mode 100644 index 00000000..e2fef943 --- /dev/null +++ b/dev/Core/index.html @@ -0,0 +1,20 @@ + 核心概览 - HydroRollCore 核心文档 (草案)
跳转至

HydroRollCore'水系核心

🎁 Getting⚓︎

  1. 安装库

在命令行输入。

1
+2
+3
+4
+5
git clone https://github.com/HydroRoll-Team/HydroRollCore.git
+cd HydroRollCore
+poetry install --no-dev
+# 或者使用pip
+# pip install HydroRollCore
+
  1. 创建规则包实例
1
+2
mkdir myrules && cd myrules && mkdir rule1
+echo.> config.toml && echo.> __init__.py :: 创建空的配置文件和python运行脚本
+

在 __init__.py 创建一个 rule 实例并继承 Rule 基类, 通过编写合适的相关方法与类注册规则包实现规则的自定义。

1
+2
+3
+4
from HydroRollCore import Rules
+
+class Myrule(Rules):
+  """自设规则包，继承 Rules 基类"""
+
  1. 合理修改你的 config.toml 配置文件，完成注册!

📄 License⚓︎

MIT © 2023-PRESENT 简律纯

最后更新: 2023-10-07
创建日期: 2023-10-07
\ No newline at end of file -- cgit v1.2.3-70-g09d2