aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
author简律纯 <leader@hydroroll.team>2024-08-10 11:51:49 +0800
committerGitHub <noreply@github.com>2024-08-10 11:51:49 +0800
commit76b990510093d7cc22ba571b3625f4725ddfc7cb (patch)
treea7c4748f77d6eedca34634aba72fc21a5ad66123
parentdfec9f99d1726b3c3a4e9426f50c955fcaddb623 (diff)
downloadHydroRoll-76b990510093d7cc22ba571b3625f4725ddfc7cb.tar.gz
HydroRoll-76b990510093d7cc22ba571b3625f4725ddfc7cb.zip
docs: beautify description
-rw-r--r--README.rst22
1 files changed, 14 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index b744bd4..39e2e3e 100644
--- a/README.rst
+++ b/README.rst
@@ -24,6 +24,8 @@
.. end-index
+----
+
安装与使用
----------
@@ -46,6 +48,8 @@
更多详细的使用方法请参考 `官方文档`_。
+----
+
开发示例
--------
@@ -77,29 +81,30 @@
python main.py
+----
+
知识问答
--------
“谁适合水系?”
~~~~~~~~~~~~~~~~~
-- 世界主——规则书作者。水系基于通用规则包(规则书的 *Python* 实现)标准架构,可以为你一键生成规则书
+:世界主: 规则书作者。水系基于通用规则包(规则书的 *Python* 实现)标准架构,可以为你一键生成规则书
的 *pdf* 版本与一个在线规则书浏览站点,同时允许你在规则包内自定义高优先级的骰系内建指令。一个规则
包,便是一个骰系。
-- 插件爱好者——下游插件开发者。水系插件可用 *lua*、 *python*、 *javascript* 编写,同时,支持在线将其他骰
+:插件爱好者: 下游插件开发者。水系插件可用 *lua*、 *python*、 *javascript* 编写,同时,支持在线将其他骰
系的插件文件(如 *shiki* 的 *lua* 脚本,青果的 *python* 插件,海豹的 *js* 插件等)转换为水系对应语言的插
件脚本实现,另有使用 *Blockly* 搭建的可视化编程站点,轻松编写插件脚本。
-- 机器学习爱好者。水系继承自多模态机器学习框架 *iamai*,能够同时训练与推理多个模型,试想你的骰子拥有
+:机器学习爱好者: 水系继承自多模态机器学习框架 *iamai*,能够同时训练与推理多个模型,试想你的骰子拥有
自己的独特人格...
-- 渴望游玩冷门规则的 *kp* 与 *pl*。
+:*kp* 与 *pl*: 水系丰富的规则包生态以及骰系生态允许渴望游玩冷门规则的他们在各种遵循水系 *GRPS* 标准的骰系
+ 中安装游玩同一个规则包文件。
“水系是什么?水系不是什么?”
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-水系是一个骰系开发框架,允许你方便快捷的开发自己的骰系。抛开人工智能模块的水系的第一用户是世界主。
-
-水系不是一个具体的骰系,但是水系有一个官方的规则书实现。在水系社区,骰系概念是被弱化的,一个加载了
-独特的规则包的骰子,便是一个骰系(针对此规则包所对应的规则书而言)。
+#. 水系是一个骰系开发框架: 允许你方便快捷的开发自己的骰系。抛开人工智能模块的水系的第一用户是世界主。
+#. 水系不是一个具体的骰系: 但是水系有一个官方的规则书与骰系实现(`传送门`_)。在水系社区,骰系概念是被弱化的,一个加载了独特的规则包的骰子,便是一个骰系(针对此规则包所对应的规则书而言)。
----
@@ -110,6 +115,7 @@
|FOSSA Status|
.. uri list above:
+.. _传送门: https://github.com/HydroRoll-Team/examples-hydro
.. _自动热重载: https://docs.hydroroll.team/addons/hot-reload
.. _调度任务: https://docs.hydroroll.team/addons/apscheduler
.. _基础模型: https://docs.hydroroll.team/addons/base-model