diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 35 |
1 files changed, 0 insertions, 35 deletions
@@ -1,14 +1,10 @@ .. raw:: html <div align="right">|logo_icon|</div> -.. raw:: html - <div align="right">|logo_icon|</div> - HydroRoll'水系 ============ |ruff| |python_v| |community| |docs| -|ruff| |python_v| |community| |docs| .. _getting: @@ -16,15 +12,10 @@ HydroRoll'水系 ---- 仅需三步即可快速搭建一个符合水系标准的骰子机器人。你也可以在我们的 `官方文档`_ 查看更详细的部署与配置教程。 -快速开始 ----- - - 仅需三步即可快速搭建一个符合水系标准的骰子机器人。你也可以在我们的 `官方文档`_ 查看更详细的部署与配置教程。 1. 安装库 推荐局部安装，使用 *pdm* 创建一个虚拟环境后在命令行输入， -推荐局部安装，使用 *pdm* 创建一个虚拟环境后在命令行输入， .. code:: shell @@ -32,22 +23,15 @@ HydroRoll'水系 这会在当前虚拟环境添加 *extra* 版本的 *HydroRoll*，包括 `自动热重载`_ (*hot-reload*)、`调度任务`_ (*apscheduler*) 与 `基础模型`_ (*base-model*) 等。 -这会在当前虚拟环境添加 *extra* 版本的 *HydroRoll*，包括 `自动热重载`_ (*hot-reload*)、`调度任务`_ (*apscheduler*) 与 `基础模型`_ (*base-model*) 等。 - 2. 创建机器人实例 在终端中输入执行以下指令， -在终端中输入执行以下指令， - .. code:: shell hydroroll new -b coc_example "HydroRoll" 这会在当前 *pwd* 环境的根目录下使用内置的 *coc_example* `规则包`_ 创建一个名为 "HydroRoll" 的骰子文件夹，您的所有骰子相关内容均在此文件夹中。 - hydroroll new -b coc_example "HydroRoll" - -这会在当前 *pwd* 环境的根目录下使用内置的 *coc_example* `规则包`_ 创建一个名为 "HydroRoll" 的骰子文件夹，您的所有骰子相关内容均在此文件夹中。 .. code:: shell @@ -64,28 +48,11 @@ HydroRoll'水系 └─frontend 3. 使用合适的适配器, 合理修改你的 *config.toml* 配置文件, 等待连接！ -.. code:: shell - - tree HydroRoll - - HydroRoll - ├─models - ├─config - ├─data - ├─rules - ├─scripts - └─web - ├─backend - └─frontend - -3. 使用合适的适配器, 合理修改你的 *config.toml* 配置文件, 等待连接！ .. code:: python hydroroll run # 使用 pdm run main.py 同理 - hydroroll run - # 使用 pdm run main.py 同理 .. _contributing: @@ -93,7 +60,6 @@ Contributing --------------- 欢迎阅读 `CONTRIBUTING.md <./CONTRIBUTING.md>`__ 对水系的各个模块与标准做出贡献。 -欢迎阅读 `CONTRIBUTING.md <./CONTRIBUTING.md>`__ 对水系的各个模块与标准做出贡献。 .. _community: @@ -103,7 +69,6 @@ Community HydroRoll'水系 的论坛在 `GitHub Discussions <https://github.com/orgs/HydroRoll-Team/discussions>`__, 你可以在这里 `提出任何问题 <https://github.com/HydroRoll-Team/HydroRoll/issues/new>`__, `分享任何想法 <https://github.com/HydroRoll-Team/HydroRoll/pulls>`__。 -你可以在这里 `提出任何问题 <https://github.com/HydroRoll-Team/HydroRoll/issues/new>`__, `分享任何想法 <https://github.com/HydroRoll-Team/HydroRoll/pulls>`__。 我们的 `行为准则(Code of Conduct) <./CODE_OF_CONDUCT.md>`__ 适用于 HydroRoll'水系 社区内的所有交流渠道。 |