ARS-docs/readme.md

22 lines
1.2 KiB
Markdown
Raw Normal View History

2023-12-05 01:39:18 +08:00
# ARS 模块收集
>This documentation is under completion.
2023-12-06 11:05:49 +08:00
## 介绍
该文档旨在收录现有的所有红石元器件,方便广大玩家快速查找并使用所需模块,降低心智负担,允许他们将精力更多倾注于构思机器架构本身而非重复造轮子,让效率最大化。:D
2023-12-05 01:39:18 +08:00
## 模块目录
- [模块目录](./modules)
2023-12-06 11:05:49 +08:00
# 贡献
欢迎有志人士为这份文档的发展贡献出自己的力量。我们坚信,星星之火,可以燎原。
为更好地帮助我们发展,我们需要你遵循以下约定:
1. 若有在`tags/tags`目录内添加新标签的需求,文件名应遵循`snake_case`命名法。
2. 若有在`modules`添加模块的需求,存放模块的文件夹名,单词与单词之间用短横隔开,且遵循该命名格式:`abbr-h_or_v-lagency-(optional)tick-(Optional)appendix`。
* 其中,`abbr`代表模块英文名称缩写(全大写);`h_or_v`代表该模块的横竖类别,例如横式模块就写`horizontal``lagency`代表模块延迟;`(Optional)tick`表示模块流水周期,有则写之,否则不写;`(Optional)appendix`代表该模块的其它附加信息,同样有则写之。
3. 模块描述应当言简意赅,避免陈词滥调。