diff options
| author | 2023-12-15 23:39:43 +0800 | |
|---|---|---|
| committer | 2023-12-15 23:39:43 +0800 | |
| commit | 1db9a0409098c42faf793d8d3210d766c4e2356f (patch) | |
| tree | e0de7daaf65b4bf2f555b1365a7a414a05531810 | |
| parent | caaf80082ed2876ba53876b94ff7fa8407692fcb (diff) | |
| download | infini-1db9a0409098c42faf793d8d3210d766c4e2356f.tar.gz infini-1db9a0409098c42faf793d8d3210d766c4e2356f.zip | |
chore(readme): update `readme.md`
| -rw-r--r-- | README.md | 20 |
1 files changed, 13 insertions, 7 deletions
@@ -82,17 +82,17 @@ ## 🌟 `contribute` -### 贡献手册 - -本段内容主要针对想要为[通用规则包标准(GRPS)]的`docs 文档` 或 `Python 实现` 作贡献的社区朋友,若您想要推广 `GRPS-1` 标准的其他语言实现,请提交相关 `PR`,届时修改下方的[资源列表]。 - 在此之前,请先克隆本仓库。 ```shell git clone https://github.com/HydroRoll-Team/infini.git ``` -接着您需要确保自己的硬件环境有 `Python` 解释器,您需要全局安装 `pdm` 依赖以实现局部开发 `infini` 文档或源码的目的。 +### 贡献手册 + +本段内容主要针对想要为[通用规则包标准(GRPS)]的`docs 文档` 或 `Python 实现` 作贡献的社区朋友,若您想要推广 `GRPS-1` 标准的其他语言实现,请提交相关 `PR`,届时修改下方的[资源列表]。 + +您需要确保自己的硬件环境有 `Python` 解释器,您需要全局安装 `pdm` 依赖以实现局部开发 `infini` 文档或源码的目的。 ```shell pip3 install pdm @@ -136,7 +136,13 @@ pdm run mkdocs serve > > 注意,强烈建议学习 [mkdocs-materials](https://squidfunk.github.io/mkdocs-material/) 的文档语法后进行文档内容的贡献 `PR`,同时还请遵循水系核心的[文档规范]。 -## 🎍 `resouces` +### 贡献源码 + +在贡献源码之前,请先知悉水系有一套渐进式开发文档,水系核心 `infini` 的开发是极其内核的,但是,此 `repo` 所代表的仅仅只是 `GRPS-1` 的一个 `Python` 实现,因此如果已经相当了解水系架构和通用规则包标准,那么可以遵循以下说明进行适当的开发。 + +水系核心主要由三部分构成:`Rule API`、`Rule Wiki`、`Rule Event-Handler`。 + +## 🎍 `resources` <https://grps.hydroroll.team> _(recommend)_ <https://grps-v1.netlify.app> @@ -148,5 +154,5 @@ pdm run mkdocs serve [通用规则包标准(GRPS)]: https://grps.hydroroll.team/dev/standard/what-is-rule-package/ -[资源列表]: https://github.com/HydroRoll-Team/infini?tab=readme-ov-file#resouces/ +[资源列表]: https://github.com/HydroRoll-Team/infini?tab=readme-ov-file#-resources [文档规范]: https://grps.hydroroll.team/dev/contribute/
\ No newline at end of file |
