To streamline your device development process, OpenHarmony provides the useful tools listed below.
**Table 1** Tools for device development
| Tool | Description | Related Resources|
| ---- | ------ | ------ |
| DevEco Device Tool | A one-stop integrated development environment (IDE) provided for developers of OpenHarmony-powered smart devices. It allows on-demand component customization, as well as code editing, compilation, burning, and debugging. The tool supports C and C++ languages and can be installed in Visual Studio Code as a plug-in.| [HUAWEI DevEco Device Tool User Guide](https://device.harmonyos.com/en/docs/documentation/guide/service_introduction-0000001050166905)|
| Docker | A containerization platform used to build and containerize applications. The Docker environments in OpenHarmony encapsulate compilation toolchains for different OpenHarmony variants, so you can start your building straightaway without having to install the compilation toolchain on your own.| [Docker Environments](gettools-acquire.md)|
@@ -11,7 +11,7 @@ The open-source code repositories are available at [https://openharmony.gitee.c
...
@@ -11,7 +11,7 @@ The open-source code repositories are available at [https://openharmony.gitee.c
You can use any of the following methods to acquire the OpenHarmony source code:
You can use any of the following methods to acquire the OpenHarmony source code:
-**Method 1**: Acquire the source code from the Gitee code repository. You can use the **repo** or **git** tool to download the latest code from the code repository.
-**Method 1**: Acquire the source code from the Gitee code repository. You can use the **repo** or **git** tool to download the latest code from the code repository.
-**Method 2**: Acquire the source code from [DevEco Marketplace](https://repo.harmonyos.com/#/en/home). Visit [DevEco Marketplace](https://repo.harmonyos.com/#/en/home), search for your desired open-source distribution, and download the bundle list \(or customize bundles and download the bundle list\). Then use **hpm-cli** to download and install the bundles and compilation toolchain on your local PC.
-**Method 2**: Acquire the source code from [DevEco Marketplace](https://repo.harmonyos.com/#/en/home). Visit [DevEco Marketplace](https://repo.harmonyos.com/#/en/home), search for your desired open-source distribution, and download the bundle list \(or customize bundles and download the bundle list\). Then use the **hpm-cli** tool to download and install the bundles and compilation toolchain on your local PC.
-**Method 3**: Download the compressed file of a distribution from a mirror site. This method provides a fast download speed, so you can also use this method for obtaining the source code of an earlier version.
-**Method 3**: Download the compressed file of a distribution from a mirror site. This method provides a fast download speed, so you can also use this method for obtaining the source code of an earlier version.
-**Method 4**: Acquire the source code from the GitHub image repository. You can use the **repo** or **git** tool to download the latest code from the code repository.
-**Method 4**: Acquire the source code from the GitHub image repository. You can use the **repo** or **git** tool to download the latest code from the code repository.
...
@@ -53,9 +53,8 @@ You can use any of the following methods to acquire the OpenHarmony source code:
...
@@ -53,9 +53,8 @@ You can use any of the following methods to acquire the OpenHarmony source code:
### How to Use<a name="section429012478331"></a>
### How to Use<a name="section429012478331"></a>
**Obtaining the Source Code for Mini/Small/Standard Systems**
>Download the master code if you want to get quick access to the latest features for your development. Download the release code, which is more stable, if you want to develop commercial functionalities.
>Download the master code if you want to get quick access to the latest features for your development. Download the release code, which is more stable, if you want to develop commercial functionalities.
-**Obtaining OpenHarmony master code**
-**Obtaining OpenHarmony master code**
...
@@ -85,7 +84,7 @@ You can use any of the following methods to acquire the OpenHarmony source code:
...
@@ -85,7 +84,7 @@ You can use any of the following methods to acquire the OpenHarmony source code:
### When to Use<a name="section26661067443"></a>
### When to Use<a name="section26661067443"></a>
If OpenHarmony is new to you, sample solutions are helpful to your development. You can obtain an open-source distribution from [DevEco Marketplace](https://repo.harmonyos.com/#/en/home), or customize a distribution by adding or deleting bundles of an open-source distribution. Then use **hpm-cli** to download and install the bundles and compilation toolchain on your local PC.
If OpenHarmony is new to you, sample solutions are helpful to your development. You can obtain an open-source distribution from [DevEco Marketplace](https://repo.harmonyos.com/#/en/home), or customize a distribution by adding or deleting bundles of an open-source distribution. Then use the **hpm-cli** tool to download and install the bundles and compilation toolchain on your local PC.
@@ -97,7 +96,7 @@ You must install **Node.js** and HPM on your local PC. The installation proced
...
@@ -97,7 +96,7 @@ You must install **Node.js** and HPM on your local PC. The installation proced
The [Node.js](https://nodejs.org/) version must be 12.x \(including npm 6.14.4\) or later. An LTS version is recommended.
The [Node.js](https://nodejs.org/) version must be 12.x \(including npm 6.14.4\) or later. An LTS version is recommended.
2. Install the hpm-cli tool using **npm** delivered with **Node.js**.
2. Install the **hpm-cli** tool using **npm** delivered with**Node.js**.
Open the CMD window and run the following command:
Open the CMD window and run the following command:
...
@@ -121,9 +120,9 @@ You must install **Node.js** and HPM on your local PC. The installation proced
...
@@ -121,9 +120,9 @@ You must install **Node.js** and HPM on your local PC. The installation proced
### How to Use<a name="section954619433333"></a>
### How to Use<a name="section954619433333"></a>
1. Search for distributions.
1. Search for distributions.
1. Access [DevEco Marketplace](https://repo.harmonyos.com/#/en/home), and click **Equipment Bundle**.
1. Access [DevEco Marketplace](https://repo.harmonyos.com/#/en/home), and click **Device**. Then go to the **Open Source Distribution** page.
2. Enter a keyword, for example, **camera**, in the search box, and click the search icon. All matched distributions will be displayed on the **Open Source Distribution** page.
2. Enter a keyword\(for example: **camera**\) in the search box. All matched distributions are found.
3. Specify filter criteria, such as the category, OS, kernel, and board, to further filter the distributions.
3. Specify filter criteria, such as the bundle type \(for example: **Board support** or **Kernel support**\), to further filter the distributions.
4. Find your desired distribution and click it to view details.
4. Find your desired distribution and click it to view details.
@@ -131,7 +130,7 @@ You must install **Node.js** and HPM on your local PC. The installation proced
...
@@ -131,7 +130,7 @@ You must install **Node.js** and HPM on your local PC. The installation proced
2. Learn more about the distribution.
2. Learn more about the distribution.
1. Read the information about the distribution to learn its application scenarios, features, bundles, usage, and customization methods, as shown in the following figure.
1. Read carefully the information about the distribution to learn its application scenarios, features, bundles, usage, and customization methods, as shown in the following figure.
2. Click **Download** to download the distribution to your local PC.
2. Click **Download** to download the distribution to your local PC.
3. Click **Custom** to add or delete bundles of the distribution.
3. Click **Custom** to add or delete bundles of the distribution.
...
@@ -142,15 +141,15 @@ You must install **Node.js** and HPM on your local PC. The installation proced
...
@@ -142,15 +141,15 @@ You must install **Node.js** and HPM on your local PC. The installation proced
1. Access the **Custom solution** page, as shown in the following figure.
1. Access the **Custom solution** page, as shown in the following figure.
2. Set the toggle switch next to a specific optional bundle to delete it from the distribution, or click **Add bundle** to add new bundles.
2. Set the toggle switch next to a specific optional bundle to delete it from the distribution, or click **Add bundle** to add new bundles.
3. Enter the basic information about your project, including the bundle name, version, and description, on the right pane.
3. Enter the basic information about your project, including the bundle name, version, and description, on the right pane.
4. Click **Download**. The system then generates the OpenHarmony code structure file \(for example, **my\_cust\_dist.zip**\) and saves it to your local PC.
4. Click **Download**. The system generates the OpenHarmony code structure file \(for example,**my\_cust\_dist.zip**\) and saves it to your local PC.
1. Decompress the downloaded code structure file using CMD on Windows \(or shell in Linux\).
1. Decompress the downloaded code structure file using CMD on Windows (or shell in Linux).
2. In the generated directory, run the **hpm install** command to download and install bundles. If the **Install successful** message is displayed, the command has been executed successfully.
2. In the generated directory, run the **hpm install** command to download and install bundles. If the **Install successful** message is displayed, the command has been executed successfully.
3.The downloaded bundles will be stored in the **ohos\_bundles** folder under the project directory. \(The source code of some bundles will be copied to a specified directory after the bundles are installed.\)
3.Obtain the bundles. The downloaded bundles are stored in the **ohos\_bundles** folder under the project directory. \(The source code of some bundles will be copied to a specified directory after the bundles are installed.\)
## Method 3: Acquiring Source Code from a Mirror Site<a name="section1186691118430"></a>
## Method 3: Acquiring Source Code from a Mirror Site<a name="section1186691118430"></a>
...
@@ -162,13 +161,13 @@ The table below provides only the sites for downloading the latest OpenHarmony m
...
@@ -162,13 +161,13 @@ The table below provides only the sites for downloading the latest OpenHarmony m
<trid="row18518114121312"><tdclass="cellrowborder"valign="top"width="25%"headers="mcps1.2.5.1.1 "><pid="p4437184283419"><aname="p4437184283419"></a><aname="p4437184283419"></a>Full code base (for mini, small, and standard systems)</p>
<trid="row18518114121312"><tdclass="cellrowborder"valign="top"width="25%"headers="mcps1.2.5.1.1 "><pid="p4437184283419"><aname="p4437184283419"></a><aname="p4437184283419"></a>Full code base (for mini, small, and standard systems)</p>
<trid="row461814235717"><tdclass="cellrowborder"valign="top"width="25%"headers="mcps1.2.5.1.1 "><pid="p0618124216579"><aname="p0618124216579"></a><aname="p0618124216579"></a>Hi3516 standard system solution (binary)</p>
<trid="row461814235717"><tdclass="cellrowborder"valign="top"width="25%"headers="mcps1.2.5.1.1 "><pid="p0618124216579"><aname="p0618124216579"></a><aname="p0618124216579"></a>Hi3516 standard system solution (binary)</p>
<trid="row162201392319"><tdclass="cellrowborder"valign="top"width="25%"headers="mcps1.2.5.1.1 "><pid="p2220191315"><aname="p2220191315"></a><aname="p2220191315"></a>RK3568 standard system solution (binary)</p>
<trid="row162201392319"><tdclass="cellrowborder"valign="top"width="25%"headers="mcps1.2.5.1.1 "><pid="p2220191315"><aname="p2220191315"></a><aname="p2220191315"></a>RK3568 standard system solution (binary)</p>
> The image repository is synchronized at 23:00 (UTC +8:00) every day.
Method 1 \(recommended\): Use the **repo** tool to download the source code over SSH. \(You must have registered an SSH public key for access to GitHub. For details, see [Adding a new SSH key to your GitHub account](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).\)
Method 1 \(recommended\): Use the **repo** tool to download the source code over SSH. \(You must have registered an SSH public key for access to GitHub. For details, see [Adding a new SSH key to your GitHub account](https://docs.github.com/en/github/authenticating-to-github/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account).\)
...
@@ -371,7 +373,7 @@ The following table describes the OpenHarmony source code directories.
...
@@ -371,7 +373,7 @@ The following table describes the OpenHarmony source code directories.
<tdclass="cellrowborder"valign="top"width="50%"headers="mcps1.2.3.1.2 "><pid="p390492919296"><aname="p390492919296"></a><aname="p390492919296"></a>Compiler and toolchain subsystem</p>
<tdclass="cellrowborder"valign="top"width="50%"headers="mcps1.2.3.1.2 "><pid="p390492919296"><aname="p390492919296"></a><aname="p390492919296"></a>Compiler and toolchain subsystem</p>