diff --git a/readme.md b/readme.md index 1b409fc..5b37a4b 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,8 @@ -# ARS 模块收集 +# ARS 模块索引 ->This documentation is under completion. +>该文档正在完善中。 + +![Doc Logo](assets/image/index.png) ## 介绍 @@ -10,7 +12,19 @@ - [模块目录](./modules) -# 贡献 +## 使用 + +你可以先将该仓库clone到本地,这需要你提前安装git: + +```bash +git clone http://shenjack.top:5100/ARS/ARS-docs.git +``` + +在仓库的`modules`目录中,选择你所需要的模块名称,进入该文件夹,其内就包含了该模块本体。 + +>待办:亟需完善具体使用步骤,如导入`.schem`文件到玩家世界的方法。 + +## 贡献 欢迎有志人士为这份文档的发展贡献出自己的力量。我们坚信,星星之火,可以燎原。 @@ -18,5 +32,5 @@ 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. 模块描述应当言简意赅,避免陈词滥调。 \ No newline at end of file + - 其中,`abbr`代表模块英文名称缩写(全大写);`h_or_v`代表该模块的横竖类别,例如横式模块就写`horizontal`;`lagency`代表模块延迟;`(Optional)tick`表示模块流水周期,有则写之,否则不写;`(Optional)appendix`代表该模块的其它附加信息,同样有则写之。 + 3. 模块内的`README.md`编写规范详见该[issue](http://shenjack.top:5100/ARS/ARS-docs/issues/4)。其中,模块描述应当言简意赅,避免陈词滥调。 \ No newline at end of file