diff --git a/modules/BCS-vertical-10gt-2t/readme.md b/modules/BCS-vertical-10gt-2t/readme.md index 73f2ab7..6e34be6 100644 --- a/modules/BCS-vertical-10gt-2t/readme.md +++ b/modules/BCS-vertical-10gt-2t/readme.md @@ -1,4 +1,4 @@ -# 借位封闭减法器（BCS, Borrow Carry Subtractor） +# 借位封闭减法器 (BCS, Borrow Carry Subtractor) ## 基本描述 diff --git a/modules/CCA-vertical-8gt/readme.md b/modules/CCA-vertical-8gt/readme.md index 22bf683..ea2ac75 100644 --- a/modules/CCA-vertical-8gt/readme.md +++ b/modules/CCA-vertical-8gt/readme.md @@ -1,4 +1,4 @@ -# 模块1 封闭进位加法器（CCA, Carry Cancel Adder） +# 模块1 封闭进位加法器 (CCA, Carry Cancel Adder) ## 基本描述 diff --git a/readme.md b/readme.md index 5b37a4b..4ffe3aa 100644 --- a/readme.md +++ b/readme.md @@ -32,5 +32,5 @@ git clone http://shenjack.top:5100/ARS/ARS-docs.git 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`代表该模块的其它附加信息，同样有则写之。 + - 其中，`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 diff --git a/tags/readme.md b/tags/readme.md index a3b4494..b5f94a5 100644 --- a/tags/readme.md +++ b/tags/readme.md @@ -6,13 +6,13 @@ - [大型模块](./tags/large_module.md) : 方块数量>100000的模块。 - [算数单元](./tags/au.md) : 具有运算功能的模块。 - [加/减法器](./tags/adder_or_subtractor.md) : 具有加/减法功能的模块。 - - [ALU（算逻单元）](./tags/alu.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/primary_module.md) : 组成整个模块的次级模块。如ALU (算术逻辑单元) ，PC (程序计数器) ，MM (主存) 等。 + - [二级模块](./tags/secondary_module.md) : 次级模块的次级模块。如CCA (进位取消全加器) ，RAM (随机存储器) ，ROM (只读存储器) 等。 - [子模块](./tags/submodule.md) : 二级模块的次级模块。如单个逻辑门，导线等。 - [Java版](./tags/je.md) : Java版模块 - [基岩版](./tags/be.md) : 基岩版模块。 diff --git a/tags/tags/2rt_pipeline.md b/tags/tags/2rt_pipeline.md index 954e685..e6a2dbb 100644 --- a/tags/tags/2rt_pipeline.md +++ b/tags/tags/2rt_pipeline.md @@ -2,4 +2,4 @@ ### 在此标签下的模块有: -- [借位封闭减法器（BCS, Borrow Carry Subtractor）](../../modules/BCS-vertical-10gt-2t/) +- [借位封闭减法器 (BCS, Borrow Carry Subtractor) ](../../modules/BCS-vertical-10gt-2t/) diff --git a/tags/tags/adder_or_subtractor.md b/tags/tags/adder_or_subtractor.md index 580fffd..28f017c 100644 --- a/tags/tags/adder_or_subtractor.md +++ b/tags/tags/adder_or_subtractor.md @@ -2,6 +2,6 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/CCA-vertical-8gt/) -- [借位封闭减法器（BCS, Borrow Carry Subtractor）](../../modules/BCS-vertical-10gt-2t/) +- [封闭进位加法器 (CCA, Carry Cancel Adder) ](../../modules/CCA-vertical-8gt/) +- [借位封闭减法器 (BCS, Borrow Carry Subtractor) ](../../modules/BCS-vertical-10gt-2t/) - [32位封闭进位加法器](../../modules/CCA-vertial-20gt-32bit/) \ No newline at end of file diff --git a/tags/tags/au.md b/tags/tags/au.md index 56180e1..ce026b6 100644 --- a/tags/tags/au.md +++ b/tags/tags/au.md @@ -2,6 +2,6 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/1-CCA-vertical-8gt/) -- [借位封闭减法器（BCS, Borrow Carry Subtractor）](../../modules/2-BCS-vertical-10gt-2t/) +- [封闭进位加法器 (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/je.md b/tags/tags/je.md index a77248a..31f95cd 100644 --- a/tags/tags/je.md +++ b/tags/tags/je.md @@ -2,6 +2,6 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/CCA-vertical-8gt/) -- [借位封闭减法器（BCS, Borrow Carry Subtractor）](../../modules/BCS-vertical-10gt-2t/) +- [封闭进位加法器 (CCA, Carry Cancel Adder) ](../../modules/CCA-vertical-8gt/) +- [借位封闭减法器 (BCS, Borrow Carry Subtractor) ](../../modules/BCS-vertical-10gt-2t/) - [32位封闭进位加法器](../../modules/CCA-vertial-20gt-32bit/) diff --git a/tags/tags/no_container.md b/tags/tags/no_container.md index 95a01f7..d4eda6e 100644 --- a/tags/tags/no_container.md +++ b/tags/tags/no_container.md @@ -2,4 +2,4 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/CCA-vertical-8gt) +- [封闭进位加法器 (CCA, Carry Cancel Adder) ](../../modules/CCA-vertical-8gt) diff --git a/tags/tags/secondary_module.md b/tags/tags/secondary_module.md index 636133d..83bce76 100644 --- a/tags/tags/secondary_module.md +++ b/tags/tags/secondary_module.md @@ -2,4 +2,4 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/CCA-vertical-8gt) +- [封闭进位加法器 (CCA, Carry Cancel Adder) ](../../modules/CCA-vertical-8gt) diff --git a/tags/tags/silent.md b/tags/tags/silent.md index b9e386a..765dfde 100644 --- a/tags/tags/silent.md +++ b/tags/tags/silent.md @@ -2,4 +2,4 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/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 index 64aa991..0b54b16 100644 --- a/tags/tags/small_module.md +++ b/tags/tags/small_module.md @@ -2,4 +2,4 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/CCA-vertical-8gt) +- [封闭进位加法器 (CCA, Carry Cancel Adder) ](../../modules/CCA-vertical-8gt) diff --git a/tags/tags/traditional_redstone.md b/tags/tags/traditional_redstone.md index 9e94f3a..04fcf7b 100644 --- a/tags/tags/traditional_redstone.md +++ b/tags/tags/traditional_redstone.md @@ -2,4 +2,4 @@ ### 在此标签下的模块有: -- [封闭进位加法器（CCA, Carry Cancel Adder）](../../modules/CCA-vertical-8gt) +- [封闭进位加法器 (CCA, Carry Cancel Adder) ](../../modules/CCA-vertical-8gt)