From b53b1c3ecf1b6c03636722b7b82900738c4fd4bf Mon Sep 17 00:00:00 2001 From: adslk Date: Mon, 27 Sep 2021 16:05:14 +0800 Subject: [PATCH] modify the readme Signed-off-by: adslk --- README.en.md | 36 --------------------------------- README.md | 39 ------------------------------------ README_zh.md | 27 +++++++++++++++++++++++++ UI/TriangleJava/README_zh.md | 2 +- 4 files changed, 28 insertions(+), 76 deletions(-) delete mode 100644 README.en.md delete mode 100644 README.md create mode 100644 README_zh.md diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 7fe88457..00000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# app_samples - -#### Description -{**When you're done, you can delete the content in this README and update the file with details for others getting started with your repository**} - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md deleted file mode 100644 index 1f549089..00000000 --- a/README.md +++ /dev/null @@ -1,39 +0,0 @@ -# app_samples - -#### 介绍 -{**以下是 Gitee 平台说明,您可以替换此简介** -Gitee 是 OSCHINA 推出的基于 Git 的代码托管平台(同时支持 SVN)。专为开发者提供稳定、高效、安全的云端软件开发协作平台 -无论是个人、团队、或是企业,都能够用 Gitee 实现代码托管、项目管理、协作开发。企业项目请看 [https://gitee.com/enterprises](https://gitee.com/enterprises)} - -#### 软件架构 -软件架构说明 - - -#### 安装教程 - -1. xxxx -2. xxxx -3. xxxx - -#### 使用说明 - -1. xxxx -2. xxxx -3. xxxx - -#### 参与贡献 - -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request - - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目,是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README_zh.md b/README_zh.md new file mode 100644 index 00000000..db24fcc9 --- /dev/null +++ b/README_zh.md @@ -0,0 +1,27 @@ +# 应用示例 + +- [概要简介](#section1470103520301) +- [使用说明](#section17988202503116) +- [约束与限制](#section18841871178) +- [相关仓](#section741114082513) + +## 概要简介 + +为帮助开发者快速熟悉HarmonyOS SDK所提供的API和应用开发流程,我们提供了一系列的应用示例,即Sample。每一个应用示例都是一个独立的DevEco Studio工程项目,开发者可以将工程导入到DevEco Studio开发工具,通过浏览代码、编译工程、安装和运行应用示例来了解应用示例中涉及API的使用方法。 + +## 使用说明 + +1. 将独立的应用示例工程导入DevEco Studio进行编译构建及运行调试。 +2. 部分应用示例中含有多个模块,开发者可以选择对单个模块进行编译构建,生成一个HAP应用安装包,也可以对整个工程进行编译构建,生成多个HAP应用安装包。 +3. 安装运行后,即可在设备上查看应用示例运行效果,以及进行相关调试。 + +## 约束与限制 + +1. 安装运行应用示例之前,请先通过config.json文件中的"deviceType"字段来确认该应用示例支持的设备类型,可尝试通过修改该字段使其可以在相应类型的设备上运行(config.json文件一般在代码的entry/src/main路径下,不同的Sample可能会有不同)。 +2. 配置开发环境时,如果您想让应用示例运行到HarmonyOS上,请参考[DevEco Studio使用说明](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)。 + + +## 相关仓 + +1. OpenHarmonyOS 系统下的应用示例:[OpenHarmonyOS_app_sample](https://gitee.com/openharmony/app_samples) + diff --git a/UI/TriangleJava/README_zh.md b/UI/TriangleJava/README_zh.md index 11782220..74d5aa8a 100644 --- a/UI/TriangleJava/README_zh.md +++ b/UI/TriangleJava/README_zh.md @@ -12,5 +12,5 @@ OpenGL是一个跨平台的高性能3D渲染API,OpenGL ES是它的嵌入式平 ### 约束与限制 -本示例仅支持在大型系统上运行。 +本示例仅支持在HarmonyOS系统上运行。 -- Gitee