diff --git a/modules/2-BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.litematic b/modules/BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.litematic similarity index 100% rename from modules/2-BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.litematic rename to modules/BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.litematic diff --git a/modules/2-BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.nbt b/modules/BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.nbt similarity index 100% rename from modules/2-BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.nbt rename to modules/BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.nbt diff --git a/modules/2-BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.schem b/modules/BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.schem similarity index 100% rename from modules/2-BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.schem rename to modules/BCS-vertical-10gt-2t/BCS-vertical-10gt-2t.schem diff --git a/modules/2-BCS-vertical-10gt-2t/readme.md b/modules/BCS-vertical-10gt-2t/readme.md similarity index 100% rename from modules/2-BCS-vertical-10gt-2t/readme.md rename to modules/BCS-vertical-10gt-2t/readme.md diff --git a/modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(bottom).nbt b/modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(bottom).nbt similarity index 100% rename from modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(bottom).nbt rename to modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(bottom).nbt diff --git a/modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(top).nbt b/modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(top).nbt similarity index 100% rename from modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(top).nbt rename to modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit(top).nbt diff --git a/modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.litematic b/modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.litematic similarity index 100% rename from modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.litematic rename to modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.litematic diff --git a/modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.schem b/modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.schem similarity index 100% rename from modules/3-CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.schem rename to modules/CCA-vertial-20gt-32bit/CCA-vertial-20gt-32bit.schem diff --git a/modules/3-CCA-vertial-20gt-32bit/readme.md b/modules/CCA-vertial-20gt-32bit/readme.md similarity index 100% rename from modules/3-CCA-vertial-20gt-32bit/readme.md rename to modules/CCA-vertial-20gt-32bit/readme.md diff --git a/modules/1-CCA-vertical-8gt/CCA-vertical-8gt.litematic b/modules/CCA-vertical-8gt/CCA-vertical-8gt.litematic similarity index 100% rename from modules/1-CCA-vertical-8gt/CCA-vertical-8gt.litematic rename to modules/CCA-vertical-8gt/CCA-vertical-8gt.litematic diff --git a/modules/1-CCA-vertical-8gt/CCA-vertical-8gt.nbt b/modules/CCA-vertical-8gt/CCA-vertical-8gt.nbt similarity index 100% rename from modules/1-CCA-vertical-8gt/CCA-vertical-8gt.nbt rename to modules/CCA-vertical-8gt/CCA-vertical-8gt.nbt diff --git a/modules/1-CCA-vertical-8gt/CCA-vertical-8gt.schem b/modules/CCA-vertical-8gt/CCA-vertical-8gt.schem similarity index 100% rename from modules/1-CCA-vertical-8gt/CCA-vertical-8gt.schem rename to modules/CCA-vertical-8gt/CCA-vertical-8gt.schem diff --git a/modules/1-CCA-vertical-8gt/readme.md b/modules/CCA-vertical-8gt/readme.md similarity index 100% rename from modules/1-CCA-vertical-8gt/readme.md rename to modules/CCA-vertical-8gt/readme.md diff --git a/modules/readme.md b/modules/readme.md index cca1292..15b0097 100644 --- a/modules/readme.md +++ b/modules/readme.md @@ -4,12 +4,12 @@ `CCA(Carry Carry Adder)` - `进位封闭加法器` -- [竖式 8gt CCA](./1-CCA-vertical-8gt) +- [竖式 8gt CCA](./CCA-vertical-8gt) -- [竖式 10gt CCA](./3-CCA-vertial-20gt-32bit) +- [竖式 10gt CCA](./CCA-vertial-20gt-32bit) ## BCS `BCS(Borrow Carry Subtractor)` - `借位封闭减法器` -- [竖式 10gt BCS](./2-BCS-vertical-10gt-2t) +- [竖式 10gt BCS](./BCS-vertical-10gt-2t) diff --git a/readme.md b/readme.md index 9e214a8..1b409fc 100644 --- a/readme.md +++ b/readme.md @@ -2,6 +2,21 @@ >This documentation is under completion. +## 介绍 + +该文档旨在收录现有的所有红石元器件,方便广大玩家快速查找并使用所需模块,降低心智负担,允许他们将精力更多倾注于构思机器架构本身而非重复造轮子,让效率最大化。:D + ## 模块目录 - [模块目录](./modules) + +# 贡献 + +欢迎有志人士为这份文档的发展贡献出自己的力量。我们坚信,星星之火,可以燎原。 + +为更好地帮助我们发展,我们需要你遵循以下约定: + + 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 diff --git a/tags/readme.md b/tags/readme.md index 85c3345..94c7e3a 100644 --- a/tags/readme.md +++ b/tags/readme.md @@ -1,26 +1,26 @@ # 标签索引 -![标签索引logo](http://shenjack.top:5100/ARS/ARS-docs/raw/branch/main/assets/image/tag_index.png) +![标签索引logo](/assets/image/tag_index.png) ### 所有可用标签: - - [小型模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Small-Module.md) : 方块数量小于10000的模块 - - [中型模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Medium-sized-module.md) : 方块数量在10001-100000之间的模块。 - - [大型模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Large-Module.md) : 方块数量>100000的模块。 - - [运算单元](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/AU.md) : 具有运算功能的模块。 - - [加/减法器](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Add-or-Subtractor.md) : 具有加/减法功能的模块。 - - [ALU(算逻单元)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/ALU.md) : 算术逻辑单元 - - [显示模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Display_Module.md) : 具备显示功能的模块。 - - [存储模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Storage-Module.md) : 具备存储功能的模块。 - - [数码管](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Digital_Display.md) : 显示数字的专用模块。 - - [成品模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Finished-module.md) : 已经完成设计的模块,如CPU - - [一级模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Primary-module.md) : 组成整个模块的次级模块。如ALU(算术逻辑单元),PC(程序计数器),MM(主存)等。 - - [二级模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Secondary-module.md) : 次级模块的次级模块。如CCA(进位取消全加器),RAM(随机存储器),ROM(只读存储器)等。 - - [子模块](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Submodule.md) : 二级模块的次级模块。如单个逻辑门,导线等。 - - [Java版](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Java-Edition.md) : Java版模块 - - [基岩版](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Bedrock-Edition.md) : 基岩版模块。 - - [版本特性](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Version-Feature.md) : 利用了版本特性的模块。 - - [2rt流水](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/2rt-pipeline.md) : 支持2rt流水线的模块。 - - [时序严格](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Strict-timing.md) : 对于电路时序要求严格的模块。 - - [无容器](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/No-Container.md) : 没有容器的模块。 - - [静音](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Silent.md) : 不会发出响声的模块。 - - [单片](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Single-chip.md) : 1高或1宽的模块。 - - [传统红石](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/tags/tags/Traditional-Redstone.md) : 仅使用红石方块特性,不使用墙电,水电,树电,脚电等其他特性的模块。 + - [小型模块](./tags/small_module.md) : 方块数量小于10000的模块 + - [中型模块](./tags/middle_size_module.md) : 方块数量在10001-100000之间的模块。 + - [大型模块](./tags/large_module.md) : 方块数量>100000的模块。 + - [算数单元](./tags/au.md) : 具有运算功能的模块。 + - [加/减法器](./tags/adder_or_subtractor.md) : 具有加/减法功能的模块。 + - [ALU(算逻单元)](./tags/alu.md) : 算术逻辑单元 + - [显示模块](./tags/display_module.md) : 具备显示功能的模块。 + - [存储模块](./tags/storage_module.md) : 具备存储功能的模块。 + - [数码管](./tags/digital_display.md) : 显示数字的专用模块。 + - [成品模块](./tags/completed_module.md) : 已经完成设计的模块,如CPU + - [一级模块](./tags/primary_module.md) : 组成整个模块的次级模块。如ALU(算术逻辑单元),PC(程序计数器),MM(主存)等。 + - [二级模块](./tags/secondary_module.md) : 次级模块的次级模块。如CCA(进位取消全加器),RAM(随机存储器),ROM(只读存储器)等。 + - [子模块](./tags/submodule.md) : 二级模块的次级模块。如单个逻辑门,导线等。 + - [Java版](./tags/je.md) : Java版模块 + - [基岩版](./tags/be.md) : 基岩版模块。 + - [版本特性](./tags/version_feature.md) : 利用了版本特性的模块。 + - [2rt流水](./tags/2rt_pipeline.md) : 支持2rt流水线的模块。 + - [时序严格](./tags/strict_timing.md) : 对于电路时序要求严格的模块。 + - [无容器](./tags/no_container.md) : 没有容器的模块。 + - [静音](./tags/silent.md) : 不会发出响声的模块。 + - [单片](./tags/single-chip.md) : 1高或1宽的模块。 + - [传统红石](./tags/traditional_redstone.md) : 仅使用红石方块特性,不使用墙电,水电,树电,脚电等其他特性的模块。   diff --git a/tags/tags/2rt-pipeline.md b/tags/tags/2rt-pipeline.md deleted file mode 100644 index 2149ba6..0000000 --- a/tags/tags/2rt-pipeline.md +++ /dev/null @@ -1,5 +0,0 @@ -# 标签索引 标签:2rt流水 - -### 在此标签下的模块有: - -- []() diff --git a/tags/tags/2rt_pipeline.md b/tags/tags/2rt_pipeline.md new file mode 100644 index 0000000..569859a --- /dev/null +++ b/tags/tags/2rt_pipeline.md @@ -0,0 +1,5 @@ +# 标签索引 标签:2rt流水 + +### 在此标签下的模块有: + +- [借位封闭减法器(BCS, Borrow Carry Subtractor)](/modules/BCS-vertical-10gt-2t/) diff --git a/tags/tags/AU.md b/tags/tags/AU.md index 615d4a6..1b329fe 100644 --- a/tags/tags/AU.md +++ b/tags/tags/AU.md @@ -1,5 +1,7 @@ -# 标签索引 标签:运算单元 +# 标签索引 标签:算数单元 ### 在此标签下的模块有: -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/1-CCA-vertical-8gt/) +- [借位封闭减法器(BCS, Borrow Carry Subtractor)](/modules/2-BCS-vertical-10gt-2t/) +- [32位封闭进位加法器](/modules/3-CCA-vertial-20gt-32bit/) \ No newline at end of file diff --git a/tags/tags/Add-or-Subtractor.md b/tags/tags/Add-or-Subtractor.md deleted file mode 100644 index d61e8fe..0000000 --- a/tags/tags/Add-or-Subtractor.md +++ /dev/null @@ -1,5 +0,0 @@ -# 标签索引 标签:加减法器 - -### 在此标签下的模块有: - -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) diff --git a/tags/tags/Java-Edition.md b/tags/tags/Java-Edition.md deleted file mode 100644 index 99a526a..0000000 --- a/tags/tags/Java-Edition.md +++ /dev/null @@ -1,5 +0,0 @@ -# 标签索引 标签:Java版 - -### 在此标签下的模块有: - -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) diff --git a/tags/tags/No-Container.md b/tags/tags/No-Container.md deleted file mode 100644 index 2073c1e..0000000 --- a/tags/tags/No-Container.md +++ /dev/null @@ -1,5 +0,0 @@ -# 标签索引 标签:无容器 - -### 在此标签下的模块有: - -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) diff --git a/tags/tags/Secondary-module.md b/tags/tags/Secondary-module.md deleted file mode 100644 index 559c879..0000000 --- a/tags/tags/Secondary-module.md +++ /dev/null @@ -1,5 +0,0 @@ -# 标签索引 标签:二级模块 - -### 在此标签下的模块有: - -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) diff --git a/tags/tags/Silent.md b/tags/tags/Silent.md index d2461f3..a3b34ed 100644 --- a/tags/tags/Silent.md +++ b/tags/tags/Silent.md @@ -2,4 +2,4 @@ ### 在此标签下的模块有: -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/CCA-vertical-8gt) diff --git a/tags/tags/Small-Module.md b/tags/tags/Small-Module.md deleted file mode 100644 index 1e0c97d..0000000 --- a/tags/tags/Small-Module.md +++ /dev/null @@ -1,5 +0,0 @@ -# 标签索引 标签:小型模块 - -### 在此标签下的模块有: - -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) diff --git a/tags/tags/Traditional-Redstone.md b/tags/tags/Traditional-Redstone.md deleted file mode 100644 index 5fe995a..0000000 --- a/tags/tags/Traditional-Redstone.md +++ /dev/null @@ -1,5 +0,0 @@ -# 标签索引 标签:传统红石 - -### 在此标签下的模块有: - -- [模块1 封闭进位加法器(CCA, Carry Cancel Adder)](http://shenjack.top:5100/ARS/ARS-docs/src/branch/main/modules/1-CCA-vertical-8gt) diff --git a/tags/tags/adder_or_subtractor.md b/tags/tags/adder_or_subtractor.md new file mode 100644 index 0000000..0d2ba6f --- /dev/null +++ b/tags/tags/adder_or_subtractor.md @@ -0,0 +1,7 @@ +# 标签索引 标签:加减法器 + +### 在此标签下的模块有: + +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/1-CCA-vertical-8gt/) +- [借位封闭减法器(BCS, Borrow Carry Subtractor)](/modules/2-BCS-vertical-10gt-2t/) +- [32位封闭进位加法器](/modules/3-CCA-vertial-20gt-32bit/) \ No newline at end of file diff --git a/tags/tags/Bedrock-Edition.md b/tags/tags/be.md similarity index 100% rename from tags/tags/Bedrock-Edition.md rename to tags/tags/be.md diff --git a/tags/tags/Finished-module.md b/tags/tags/completed_module.md similarity index 100% rename from tags/tags/Finished-module.md rename to tags/tags/completed_module.md diff --git a/tags/tags/Display-Module.md b/tags/tags/display_module.md similarity index 100% rename from tags/tags/Display-Module.md rename to tags/tags/display_module.md diff --git a/tags/tags/je.md b/tags/tags/je.md new file mode 100644 index 0000000..eedb1a4 --- /dev/null +++ b/tags/tags/je.md @@ -0,0 +1,7 @@ +# 标签索引 标签:Java版 + +### 在此标签下的模块有: + +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/1-CCA-vertical-8gt/) +- [借位封闭减法器(BCS, Borrow Carry Subtractor)](/modules/2-BCS-vertical-10gt-2t/) +- [32位封闭进位加法器](/modules/3-CCA-vertial-20gt-32bit/) diff --git a/tags/tags/Large-Module.md b/tags/tags/large_module.md similarity index 100% rename from tags/tags/Large-Module.md rename to tags/tags/large_module.md diff --git a/tags/tags/Medium-sized-module.md b/tags/tags/middle_size_module.md similarity index 100% rename from tags/tags/Medium-sized-module.md rename to tags/tags/middle_size_module.md diff --git a/tags/tags/no_container.md b/tags/tags/no_container.md new file mode 100644 index 0000000..6e8168e --- /dev/null +++ b/tags/tags/no_container.md @@ -0,0 +1,5 @@ +# 标签索引 标签:无容器 + +### 在此标签下的模块有: + +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/CCA-vertical-8gt) diff --git a/tags/tags/Primary-module.md b/tags/tags/primary_module.md similarity index 100% rename from tags/tags/Primary-module.md rename to tags/tags/primary_module.md diff --git a/tags/tags/secondary_module.md b/tags/tags/secondary_module.md new file mode 100644 index 0000000..e47dee6 --- /dev/null +++ b/tags/tags/secondary_module.md @@ -0,0 +1,5 @@ +# 标签索引 标签:二级模块 + +### 在此标签下的模块有: + +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/CCA-vertical-8gt) diff --git a/tags/tags/small_module.md b/tags/tags/small_module.md new file mode 100644 index 0000000..1880a41 --- /dev/null +++ b/tags/tags/small_module.md @@ -0,0 +1,5 @@ +# 标签索引 标签:小型模块 + +### 在此标签下的模块有: + +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/CCA-vertical-8gt) diff --git a/tags/tags/Storage-Module.md b/tags/tags/storage_module.md similarity index 100% rename from tags/tags/Storage-Module.md rename to tags/tags/storage_module.md diff --git a/tags/tags/Strict-timing.md b/tags/tags/strict_timing.md similarity index 100% rename from tags/tags/Strict-timing.md rename to tags/tags/strict_timing.md diff --git a/tags/tags/traditional_redstone.md b/tags/tags/traditional_redstone.md new file mode 100644 index 0000000..72259fc --- /dev/null +++ b/tags/tags/traditional_redstone.md @@ -0,0 +1,5 @@ +# 标签索引 标签:传统红石 + +### 在此标签下的模块有: + +- [封闭进位加法器(CCA, Carry Cancel Adder)](/modules/CCA-vertical-8gt) diff --git a/tags/tags/Version-Feature.md b/tags/tags/version_feature.md similarity index 100% rename from tags/tags/Version-Feature.md rename to tags/tags/version_feature.md