From 1262f789002b7141c03bdabd9f12be5b6fd00431 Mon Sep 17 00:00:00 2001
From: xuzijay <8628214+xuzijay@user.noreply.gitee.com>
Date: Sat, 27 Nov 2021 07:25:39 +0000
Subject: [PATCH] update README.md.
---
README.md | 30 ++++++++++++++++++++++++++----
1 file changed, 26 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index fc822c52..8617a146 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,29 @@
-# OpenHarmony Codelabs
+# OpenHarmony Codelabs
-OpenHarmony Codelabs旨在向开发人员展示如何通过趣味场景来展示如何使用OpenHarmony能力的示例应用程序文档教程。
+- [概要简介](#section117915431558)
+- [使用说明](#section1954919258619)
+- [约束与限制](#section682025019613)
+- [相关仓](#section01752910717)
-HarmonyOS Codelabs 已迁移至 https://gitee.com/harmonyos/harmonyos_codelabs ,后续不在此仓库更新。
+## 概要简介
+
+为帮助开发者快速熟悉HarmonyOS和OpenHarmony的能力以及相关的应用开发流程,我们提供了一系列的基于趣味场景的应用示例,即Codelabs,开发者可以根据我们的文档一步步的学习和完成简单项目的开发。
+
+## 使用说明
+
+1. 将独立的应用示例工程导入DevEco Studio进行编译构建及运行调试。
+2. 部分应用示例中含有多个模块,开发者可以选择对单个模块进行编译构建,生成一个HAP应用安装包,也可以对整个工程进行编译构建,生成多个HAP应用安装包。
+3. 安装运行后,即可在设备上查看应用示例运行效果,以及进行相关调试。
+
+## 约束与限制
+
+1. 安装运行应用示例之前,请先通过config.json文件中的"deviceType"字段来确认该应用示例支持的设备类型,可尝试通过修改该字段使其可以在相应类型的设备上运行(config.json文件一般在代码的entry/src/main路径下,不同的Codelabs可能会有不同)。
+2. 配置开发环境时,如果您想让应用示例运行到HarmonyOS上,请参考[DevEco Studio使用说明](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)。如果您想让应用示例运行到OpenHarmony上,请参考[DevEco Studio(OpenHarmony)使用指南](https://gitee.com/openharmony/docs/blob/master/zh-cn/application-dev/quick-start/Readme-CN.md)。
+3. IDE版本及配套SDK问题,可前往[DevEco Studio版本说明](https://developer.harmonyos.com/cn/docs/documentation/doc-releases/release_notes-0000001057597449)来查看详细的IDE、SDK、插件及Gradle配套版本。
+4. 所有HarmonyOS相关Codelabs代码已被全部迁移至[Harmony组织](https://gitee.com/harmonyos)之下的[harmonyos\_codelabs](https://gitee.com/harmonyos/harmonyos_codelabs)仓中,本仓中不再体现。
+
+## 相关仓
+
+1. HarmonyOS Codelabs仓:[harmonyos\_codelabs](https://gitee.com/harmonyos/harmonyos_codelabs)
+2. HarmonyOS Codelabs官网:[HarmonyOS Codelabs](https://developer.harmonyos.com/cn/documentation/codelabs/)
-注意:IDE版本及配套SDK问题可前往https://developer.harmonyos.com/cn/develop/deveco-studio#download 查看配套的IDE、SDK、插件及Gradle版本。
\ No newline at end of file
--
Gitee