From 31641b8dc524d926f0501ec2a2c8b5efb825fbf2 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Fri, 23 Jun 2023 07:37:31 +0800 Subject: Update README.md --- README.md | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 84 insertions(+), 14 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 27ce38ab..4fa8f848 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,93 @@ -

-

- retro docs -

- Cross-platform robot framework, mainly used for ML. + + +

HydroRoll'水系

+

+

- - Latest version + + + + + + + + + +

+ + + + +

-

-## 👀 See the docs -> choices below. +水系是一个基于深度学习框架iamai的跨平台骰系，尽管只是作为iamai的插件示例，但它仍然有自己的创新之处与标准遵循: + +- **语法高度严谨且自由**: 命令语法贴切实际，输入灵活方便。 + +- **概念继承但焕然一新**: 因为开发者混迹的骰系群以及使用过的骰系很多，因此继承学习了相当一部分各个骰系做的比较好的地方，同时也引入了诸多类似(规则模块、世界主、模型模块)等概念。 + +## 🎁 Getting + +1. 安装库 + +在命令行输入。 + +``` shell +pip install HydroRollCore +``` + +2. 创建机器人实例 + +``` shell +mkdir mybot && cd mybot && mkdir plugins +echo.> config.toml && echo.> main.py :: 创建空的配置文件和python运行脚本 +``` + +在 `main.py` 导入 `Bot` 类, 创建一个 `bot` 实例并开启热加载, 最后通过 `run` 方法启动水系骰娘。 + +``` python +from hydroroll import Bot + +bot = Bot(hot_reload=True) + +if __name__ == "__main__": + bot.run() +``` + +3. 使用合适的适配器, 合理修改你的 `config.toml` 配置文件, 等待连接! + +## 💕 Contributing + +欢迎阅读 [CONTRIBUTING.md](./CONTRIBUTING.md) + +## 🙋‍ Community + +HydroRoll 水系 的论坛在 [GitHub Discussions](https://github.com/HydroRoll-Team/HydroRoll/discussions), 你可以在这里提出任何问题, 分享任何想法。 + +目前你可以加入 [![](https://img.shields.io/badge/-QQ群126211793-002FA7?style=flat-square&logo=TencentQQ&logoColor=white)]() 和社区里的其它用户交流, 同时也能在里面体验到最新开发的水系骰子(krypton)。 + +我们的 [行为准则(Code of Conduct)](https://github.com/retrofor/HydroRoll/blob/main/CODE_OF_CONDUCT.md) 适用于 HydroRoll'水系 社区内的所有交流渠道。 + +## ✨ Updates + +1. 使用 `pip` 更新 + +``` shell +pip install --upgrade HydroRollCore +``` + + +## 👨‍🚀 Contributors + + + + -- _(recommend)_ -- -- ~~~~ ## 📄 License -[GNU GPLv3.0](https://github.com/retrofor/retro_pkg_test/blob/master/LICENSE) © 2023-PRESENT [简律纯](https://github.com/HsiangNianian) + +[GPL 3.0](https://github.com/HydroRoll-Team/HydroRollCore/blob/main/LICENSE) © 2023-PRESENT [简律纯](https://github.com/HsiangNianian) -- cgit v1.2.3-70-g09d2