Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
Coping0606
Docs
提交
eab6bac9
D
Docs
项目概览
Coping0606
/
Docs
与 Fork 源项目一致
Fork自
OpenHarmony / Docs
通知
1
Star
1
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
未验证
提交
eab6bac9
编写于
5月 31, 2022
作者:
O
openharmony_ci
提交者:
Gitee
5月 31, 2022
浏览文件
操作
浏览文件
下载
差异文件
!4168 【OpenHarmony开源贡献者计划2022】update README-template.md
Merge pull request !4168 from Mr_YX/master
上级
79b67ac2
b620eacd
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
9 addition
and
8 deletion
+9
-8
zh-cn/contribute/template/README-template.md
zh-cn/contribute/template/README-template.md
+9
-8
未找到文件。
zh-cn/contribute/template/README-template.md
浏览文件 @
eab6bac9
# 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
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录