diff --git a/zh-cn/contribute/template/README-template.md b/zh-cn/contribute/template/README-template.md index 5cd6423131a6446b4b7fa4c3815a9d67426a5459..ffb8814a0f56b1056d25e88412b25b23ddc8b36a 100644 --- a/zh-cn/contribute/template/README-template.md +++ b/zh-cn/contribute/template/README-template.md @@ -1,7 +1,7 @@ # xxx子系统/部件 -【标题说明】根据当前Readme的类型,使用 **子系统**或者 **部件**。 +【标题说明】根据当前Readme的类型,使用**子系统**或者**部件**。 ![子系统readme](figures/figure01.png) @@ -10,13 +10,13 @@ ## 简介 -【写作要求】 必选**,简介中包含2部分内容: **内容介绍、架构图介绍。 +【写作要求】 **必选** ,**简介中包含2部分内容**:内容介绍、架构图介绍。 -**内容介绍:**从以下几个方面介绍该子系统:出现背景(在整个OpenHarmony架构中的作用)、实现的功能、使用场景、支持的设备等。 +**内容介绍**:从以下几个方面介绍该子系统:出现背景(在整个OpenHarmony架构中的作用)、实现的功能、使用场景、支持的设备等。 -**架构图:**使用架构图说明该子系统【部件】架构,对架构中的主要组成部分进行必要的解释说明 +**架构图**:使用架构图说明该子系统【部件】架构,对架构中的主要组成部分进行必要的解释说明 -**如果本部件仓库只是子系统一部分,需要理解子系统相关概念,建议给出:** +**如果本部件仓库只是子系统一部分,需要理解子系统相关概念,建议给出**: **更多XXX子系统相关概念,请参考:xxx。(给出到子系统readme的链接)** @@ -56,13 +56,14 @@ 架构图参考如下,注意需要绘图的 **颜色,格式有规范要求**,请参照: **图1** 子系统架构图 + ![架构图](figures/figure02.png) ## 目录 -【写作要求】 必选**,明确本项目仓的代码 **目录结构**以及对应目录的 **功能描述 +【写作要求】 **必选** ,**明确本项目仓的代码**目录结构**以及对应目录的**功能描述 ```undefined /foundation/ace @@ -94,7 +95,7 @@ ## 编译构建/使用方法 -【写作要求】 可选,子系统Readme不需要提供,对于部件仓的Readme,根据实际情况,提供编译构建的说明。 +【写作要求】 **可选** ,子系统Readme不需要提供,对于部件仓的Readme,根据实际情况,提供编译构建的说明。 ## 说明 @@ -149,4 +150,4 @@ [drivers\_liteos](https://gitee.com/openharmony/drivers_liteos/blob/master/README_zh.md) -**kernel\_liteos\_a** \ No newline at end of file +[**kernel\_liteos\_a**](https://gitee.com/openharmony/kernel_liteos_a/blob/master/README_zh.md) \ No newline at end of file