aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2023-06-23 07:37:31 +0800
committerGitHub <noreply@github.com>2023-06-23 07:37:31 +0800
commit31641b8dc524d926f0501ec2a2c8b5efb825fbf2 (patch)
tree359e5e2b819e9f5e1cc3781ef5441d68d6762241 /README.md
parentbf040f4bc5fe014c092422b4ccbdb227d04d85e5 (diff)
downloadinfini-31641b8dc524d926f0501ec2a2c8b5efb825fbf2.tar.gz
infini-31641b8dc524d926f0501ec2a2c8b5efb825fbf2.zip
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md98
1 files changed, 84 insertions, 14 deletions
diff --git a/README.md b/README.md
index 27ce38ab..4fa8f848 100644
--- a/README.md
+++ b/README.md
@@ -1,23 +1,93 @@
-<p align="center"><img width="128" src="https://iamai.retrofor.space/retro.png"></p>
-<h1 align="center">
- retro docs
-</h1>
<p align="center">
- Cross-platform robot framework, mainly used for ML.
+ <a href="https://hydroroll.retrofor.space">
+ <img src="https://hydroroll.retrofor.space/background_or_logo.png" height="128">
+ <h1 align="center">HydroRoll'水系</h1>
+ </a>
</p>
+
<p align="center">
- <a style="text-decoration:none" href="https://github.com/retrofor/retro_pkg_test/releases" target="_blank">
- <img src="https://img.shields.io/github/release/retrofor/retro_pkg_test.svg" alt="Latest version" />
+ <a aria-label="Vercel Site" href="https://hydroroll.retrofor.space/" target="blank">
+ <img src="https://img.shields.io/badge/DOCS%20AND%20BLOGS-000000.svg?logo=Vercel&labelColor=000">
+ </a>
+ <a aria-label="PYTHON version" href="https://pypi.org/project/hydrorollcore" target="blank">
+ <img alt="" src="https://img.shields.io/pypi/v/hydroroll.svg?labelColor=000000">
+ </a>
+ <a aria-label="Join the community on GitHub" href="https://github.com/HydroRoll-Team/hydroroll/discussions" target="blank">
+ <img alt="" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?logo=data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8CAgL/CgoK/woKCv8GBgb/BgYG/woKCv8KCgr/AgIC/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/BgYG/0ZGRv9MTEz/JiYm/ygoKP9MTEz/RkZG/wYGBv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9ycnL/Li4u/1xcXP9eXl7/Li4u/3Jycv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP88PDz/cnJy/05OTv9OTk7/UFBQ/05OTv9wcHD/Pj4+/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/Kioq/3Jycv9cXFz/TExM/05OTv9aWlr/cHBw/yoqKv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/Pj4+/zg4OP+AgID/Pj4+/2ZmZv9oaGj/PDw8/4CAgP86Ojr/Pj4+/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/ywsLP9iYmL/enp6/zIyMv90dHT/dHR0/zAwMP98fHz/YmJi/ywsLP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9SUlL/PDw8/3Jycv9CQkL/UlJS/1RUVP9CQkL/cnJy/zw8PP9SUlL/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/VFRU/yIiIv9aWlr/PDw8/zw8PP8+Pj7/PDw8/1hYWP8iIiL/VFRU/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/zQ0NP9CQkL/ZmZm/yIiIv9WVlb/WFhY/yIiIv9mZmb/QkJC/zY2Nv8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP9QUFD/BgYG/0RERP9KSkr/JCQk/yYmJv9KSkr/RERE/wgICP9QUFD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/CgoK/wICAv8KCgr/CgoK/wYGBv8GBgb/CgoK/woKCv8CAgL/CgoK/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA==&labelColor=000000&logoWidth=20&logoColor=white">
+ </a>
+ <br></br>
+ <a aria-label="Vercel Site" href="https://hydroroll.retrofor.space/" target="blank">
+ <img src="https://img.shields.io/pypi/pyversions/hydroroll?labelColor=000000">
+ </a>
+ <a aria-label="License" href="https://github.com/HydroRoll-Team/hydroroll/blob/main/LICENSE" target="blank">
+ <img alt="" src="https://img.shields.io/pypi/l/hydroroll.svg?labelColor=000000&color=">
</a>
</p>
-<p align="center"><img width="512" src="https://raw.githubusercontent.com/retrofor/retrofor.github.io/master/static/img/logo.png"></p>
-## 👀 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
+
+<a href="https://github.com/HydroRoll-Team/HydroRollCore/graphs/contributors">
+ <img width="150" src="https://contrib.rocks/image?repo=HydroRoll-Team/HydroRollCore" />
+</a>
-- <https://doc.retrofor.space> _(recommend)_
-- <https://retrofor.netlify.app>
-- ~~<https://retrofor.github.io>~~
## 📄 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)