Skip to content
Snippets Groups Projects
Commit 746100d0 authored by Gururaj Shetty's avatar Gururaj Shetty
Browse files

Refactoring the documentation

> Supported boards moved to new folder
> Titles updated as per review for code and tools downloading
> References and link issue fixed
parent 2ea9abc0
No related branches found
No related tags found
No related merge requests found
......@@ -6,7 +6,8 @@ Welcome to |main_project_name| documentation!
.. toctree::
:maxdepth: 1
overview/Readme-EN
quick-start/Readme-EN
readme/Readme-EN
overview/Readme
quick-start/build-open-harmony
supported-boards/Readme
readme/Readme
term/glossary
.. include:: ../definitions.rst
Getting Started
###############
.. toctree::
:maxdepth: 2
build-open-harmony
supported-boards
.. BuildOpenharmony:
.. _BuildOpenharmony:
.. include:: ../definitions.rst
Building OpenHarmony Image
##########################
Getting Started
###############
OpenHarmony is a distributed OS that is designed to run on top of variety of OS kernels ranging from RTOSs to Linux. To build OpenHarmony image, you need to add multiple layers called **meta-ohos**. The **meta-ohos** is a set of bitbake layers for building OpenHarmony images using the bitbake infrastructure, it is a _umbrella_ meta layer containing all layers required to build. This section describes the architecture of **meta-ohos** and procedures invloved in building and running the OpenHarmony image using supported kernels.
|main_project_name| is a distributed OS that is designed to run on top of a variety of OS kernels ranging from Linux to RTOSs. To start with, you can build an |main_project_name| image using your preferred OS flavour using the supported boards. Currently, |main_project_name| supports Linux, Zephyr, and FreeRTOS kernels. The supported boards are listed in the following sections. The configuration is set with certain default values which can be customized as per your preference.
This topic provides an overview of meta-ohos architecture, tools, and source code required to build your |main_project_name| image. The meta-ohos is an umbrella meta-layer containing all layers required to build
|main_project_name| Image on existing kernel meta-layers.
**Figure 1 meta-ohos overview**
......@@ -14,11 +17,12 @@ OpenHarmony is a distributed OS that is designed to run on top of variety of OS
:align: center
:alt: meta-ohos overview
Building and Running OpenHarmony image
************************************************
**Prerequisite**
.. _tool-acquisition:
To start working with **meta-ohos** first install git repo:
Downloading Tools
***********************
To start with, you need to install git-repo by executing the following command. Git-repo helps you to manage repositories, revision control systems, and automate parts of the development workflow.
.. code-block:: console
......@@ -26,9 +30,12 @@ To start working with **meta-ohos** first install git repo:
$ sudo apt-get update
$ sudo apt-get install git-repo
**Procedure**
.. _source-code-acquisition:
Downloading Source Code
********************************
Once git repo has been installed as mentioned in prerequisite, clone the necessary repositories by executing the following commands:
Once git-repo has been installed, clone the necessary repositories by executing the following commands:
.. code-block:: console
......@@ -49,7 +56,12 @@ Once git repo has been installed as mentioned in prerequisite, clone the necessa
├── <various yocto layers>
└── poky
OpenHarmony can be hosted on top of variety of kernels. Currently supported kernels (a.k.a. OHOS flavours) are Linux, Zephyr, and FreeRTOS (experimental).
.. _building-image:
Building and Running |main_project_name| image
************************************************
|main_project_name| can be hosted on top of variety of kernels. Currently supported kernels (a.k.a. OHOS flavours) are Linux, Zephyr, and FreeRTOS (experimental).
To build OHOS flavour, use the following command syntax:
......
.. _avenger96:
.. include:: ../definitions.rst
96Boards Avenger96
......
.. _nitogen:
.. include:: ../definitions.rst
96Boards Nitrogen
......
.. supported-boards:
.. include:: ../definitions.rst
Supported Boards
......@@ -5,7 +7,12 @@ Supported Boards
Harmony OS supports the following boards:
* `96Boards Nitrogen <https://git.ostc-eu.org/Arul/developer-guide/-/blob/master/documentation/source/quick-start/96b-nitrogen.rst>`_
* `96Boards Avenger96 <https://git.ostc-eu.org/Arul/developer-guide/-/blob/master/documentation/source/quick-start/96b-Avenger.rst>`_
.. toctree::
:maxdepth: 1
96b-Avenger
96b-nitrogen
For more information on supported boards and instructions to use them, see https://git.ostc-eu.org/OSTC/OHOS/docs/supported-boards.
......@@ -8,6 +8,9 @@ The traditional OSs are limited to a specific type of device, OpenHarmony provid
OpenHarmony Documentation
***********************************
* `Getting Started <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/quick-start/build-open-harmony.rst>`_
* `Supported Boards <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/quick-start/supported-boards.rst>`_
For latest OpenHarmony Documentation, `Click <https://openharmony-documentation.readthedocs.io>`_.
Start Contributing
......@@ -19,6 +22,13 @@ OpenHarmony is an Open Source Community and encourages everyone in the community
For more details on Contribution, see `Contributing to the Documentation <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contributing%20to%20the%20Documentation.rst>`_.
Get Source Code and Tools
*********************************
To download the source code and tools required for the project, click the following links:
* Downloading Tools
* Downloading Source Code
Where to Turn for Help
**********************
You can subscribe to the mailing list to get constant updates on new features, release road maps, and community activities. For Subscribing to the mailing list or any other support, see `Communication in Community <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Communication%20in%20Community.rst>`_.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment