未验证 提交 b620eacd 编写于 作者: Mr-YX's avatar Mr-YX 提交者: Gitee

update zh-cn/contribute/template/README-template.md.

Signed-off-by: Mr-YX's avatarMr_YX <496043997@qq.com>
上级 c2d0a122
# xxx子系统/部件 # xxx子系统/部件
【标题说明】根据当前Readme的类型,使用 **子系统**或者 **部件** 【标题说明】根据当前Readme的类型,使用**子系统**或者**部件**
![子系统readme](figures/figure01.png) ![子系统readme](figures/figure01.png)
...@@ -10,9 +10,9 @@ ...@@ -10,9 +10,9 @@
## 简介 ## 简介
【写作要求】 必选**简介中包含2部分内容**:内容介绍、架构图介绍。 【写作要求】 **必选** **简介中包含2部分内容**:内容介绍、架构图介绍。
**内容介绍:**从以下几个方面介绍该子系统:出现背景(在整个OpenHarmony架构中的作用)、实现的功能、使用场景、支持的设备等。 **内容介绍**从以下几个方面介绍该子系统:出现背景(在整个OpenHarmony架构中的作用)、实现的功能、使用场景、支持的设备等。
**架构图**:使用架构图说明该子系统【部件】架构,对架构中的主要组成部分进行必要的解释说明 **架构图**:使用架构图说明该子系统【部件】架构,对架构中的主要组成部分进行必要的解释说明
...@@ -56,13 +56,14 @@ ...@@ -56,13 +56,14 @@
架构图参考如下,注意需要绘图的 **颜色,格式有规范要求**,请参照: 架构图参考如下,注意需要绘图的 **颜色,格式有规范要求**,请参照:
**图1** 子系统架构图 **图1** 子系统架构图
![架构图](figures/figure02.png) ![架构图](figures/figure02.png)
## 目录 ## 目录
【写作要求】 必选**明确本项目仓的代码**目录结构**以及对应目录的**功能描述 【写作要求】 **必选** **明确本项目仓的代码**目录结构**以及对应目录的**功能描述
```undefined ```undefined
/foundation/ace /foundation/ace
...@@ -94,7 +95,7 @@ ...@@ -94,7 +95,7 @@
## 编译构建/使用方法 ## 编译构建/使用方法
【写作要求】 可选,子系统Readme不需要提供,对于部件仓的Readme,根据实际情况,提供编译构建的说明。 【写作要求】 **可选** ,子系统Readme不需要提供,对于部件仓的Readme,根据实际情况,提供编译构建的说明。
## 说明 ## 说明
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册