diff --git a/README.md b/README.md index 5fb277d0eeb22705a89de6b51415e568edda727e..cc97540807217b5100128e5732688c9771a3086c 100755 --- a/README.md +++ b/README.md @@ -4,22 +4,22 @@ - [Usage](#section17988202503116) - [Limitations](#section18841871178) - [Repositories Involved](#section741114082513) -- [Licensing](#section5315468537) ## Introduction -OpenHarmony provides a series of app samples to help you quickly get familiar with the APIs and app development process of the OpenHarmony SDK. Each app sample is an independent project in DevEco Studio. You can import a project into DevEco Studio to learn how to use APIs in the sample by browsing code, building the project, and installing and running the app. +We provide a series of app samples to help you quickly get familiar with the APIs and app development process of the HarmonyOS and OpenHarmony SDKs. Each app sample is an independent project in DevEco Studio. You can import a project into DevEco Studio to learn how to use APIs in the sample by browsing code, building the project, and installing and running the app. ## Usage -1. Import an independent app sample project into DevEco Studio for compilation, building, running, and debugging. For details, see [HUAWEI DevEco Studio User Guide](https://developer.harmonyos.com/en/docs/documentation/doc-guides/tools_overview-0000001053582387). +1. Import an independent app sample project into DevEco Studio for compilation, building, running, and debugging. 2. Some samples contain multiple modules. You can compile and build a single module to generate a HAP file or compile and build the entire project to generate multiple HAP files. 3. After HAP installation and execution, you can view the execution effect of the sample on the device and then conduct debugging. ## Limitations 1. Before installing and running the sample, check the **deviceType** field in the **config.json** file to obtain the device types supported by the sample. You can modify this field to enable the sample to run on your target device. \(The **config.json** file is generally stored in the **entry/src/main** directory, which may be different depending on the samples.\) -2. App samples in the following directories can run on the standard system \(reference memory ≥ 128 MiB\). Other app examples can run only on the large system \(reference memory ≥ 1 GiB\): +2. If you want to run the app sample on HarmonyOS, configure the development environment by referring to [HUAWEI DevEco Studio User Guide](https://developer.harmonyos.com/en/docs/documentation/doc-guides/tools_overview-0000001053582387). If you want to run the app sample on OpenHarmony, configure the development environment by referring to [DevEco Studio \(OpenHarmony\) User Guide](https://gitee.com/openharmony/docs/blob/master/en/application-dev/quick-start/deveco-studio-(openharmony)-user-guide.md). +3. The following app samples can run on OpenHarmony, and other app samples can run only on HarmonyOS: - common/Clock - common/JsHelloWorld @@ -27,4 +27,4 @@ OpenHarmony provides a series of app samples to help you quickly get familiar wi ## Repositories Involved 1. [applications\_sample\_camera](https://gitee.com/openharmony/applications_sample_camera/blob/master/README.md) -2. [applications\_sample\_wifi\_iot](https://gitee.com/openharmony/applications_sample_wifi_iot/blob/master/README.md) +2. [applications\_sample\_wifi\_iot](https://gitee.com/openharmony/applications_sample_wifi_iot/blob/master/README.md) \ No newline at end of file diff --git a/README_zh.md b/README_zh.md index f1c1b7de8fb1fd7bfcfabd1bc148a8965b234264..c8fef39b3fb170cf3d0f4003758cade7a3ed6838 100755 --- a/README_zh.md +++ b/README_zh.md @@ -4,22 +4,22 @@ - [使用说明](#section17988202503116) - [约束与限制](#section18841871178) - [相关仓](#section741114082513) -- [许可证](#section5315468537) ## 概要简介 -为帮助开发者快速熟悉OpenHarmony SDK所提供的API和应用开发流程，OpenHarmony提供了一系列的应用示例，即Sample。每一个应用示例都是一个独立的DevEco Studio工程项目，开发者可以将工程导入到DevEco Studio开发工具，通过浏览代码、编译工程、安装和运行应用示例来了解应用示例中涉及API的使用方法。 +为帮助开发者快速熟悉HarmonyOS和OpenHarmony SDK所提供的API和应用开发流程，我们提供了一系列的应用示例，即Sample。每一个应用示例都是一个独立的DevEco Studio工程项目，开发者可以将工程导入到DevEco Studio开发工具，通过浏览代码、编译工程、安装和运行应用示例来了解应用示例中涉及API的使用方法。 ## 使用说明 -1. 将独立的应用示例工程导入DevEco Studio进行编译构建及运行调试，具体使用可参考[DevEco Studio使用说明](https://developer.harmonyos.com/cn/docs/documentation/doc-guides/tools_overview-0000001053582387)。 +1. 将独立的应用示例工程导入DevEco Studio进行编译构建及运行调试。 2. 部分应用示例中含有多个模块，开发者可以选择对单个模块进行编译构建，生成一个HAP应用安装包，也可以对整个工程进行编译构建，生成多个HAP应用安装包。 3. 安装运行后，即可在设备上查看应用示例运行效果，以及进行相关调试。 ## 约束与限制 1. 安装运行应用示例之前，请先通过config.json文件中的"deviceType"字段来确认该应用示例支持的设备类型，可尝试通过修改该字段使其可以在相应类型的设备上运行（config.json文件一般在代码的entry/src/main路径下，不同的Sample可能会有不同）。 -2. 以下路径下的应用示例支持在**标准系统**（参考内存≥128MiB）上运行，其余应用示例仅支持在**大型系统**（参考内存≥1GiB）上运行。 +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/DevEco-Studio%EF%BC%88OpenHarmony%EF%BC%89%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97.md)。 +3. 以下路径下的应用示例支持在OpenHarmony上运行，其余应用示例仅支持在HarmonyOS上运行。 - common/Clock - common/JsHelloWorld @@ -27,7 +27,4 @@ ## 相关仓 1. CAMERA\_SAMPLE\_APP组件的应用示例：[applications\_sample\_camera](https://gitee.com/openharmony/applications_sample_camera/blob/master/README_zh.md) -2. WIFI\_IOT\_APP组件的应用示例：[applications\_sample\_wifi\_iot](https://gitee.com/openharmony/applications_sample_wifi_iot/blob/master/README_zh.md) - - - +2. WIFI\_IOT\_APP组件的应用示例：[applications\_sample\_wifi\_iot](https://gitee.com/openharmony/applications_sample_wifi_iot/blob/master/README_zh.md) \ No newline at end of file