diff --git a/documentation/source/index.rst b/documentation/source/index.rst index 12c4910b95a7cd0ee4701e1225494b7fa6442ed5..e887a25c903f3cbc4662d062703cd8c30ec2478d 100644 --- a/documentation/source/index.rst +++ b/documentation/source/index.rst @@ -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 diff --git a/documentation/source/overview/Readme-EN.rst b/documentation/source/overview/Readme.rst similarity index 100% rename from documentation/source/overview/Readme-EN.rst rename to documentation/source/overview/Readme.rst diff --git a/documentation/source/quick-start/Readme-EN.rst b/documentation/source/quick-start/Readme-EN.rst deleted file mode 100644 index 40c3d804267d020dc36b0ee2ac0c12b765c92605..0000000000000000000000000000000000000000 --- a/documentation/source/quick-start/Readme-EN.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. include:: ../definitions.rst - -Getting Started -############### - -.. toctree:: - :maxdepth: 2 - - build-open-harmony - supported-boards - - - diff --git a/documentation/source/quick-start/build-open-harmony.rst b/documentation/source/quick-start/build-open-harmony.rst index 06927d5e02d54c21367cea048b3ef9ba5a549ed8..85446a51295f2232e4f5bfff1b2cd5190715d489 100644 --- a/documentation/source/quick-start/build-open-harmony.rst +++ b/documentation/source/quick-start/build-open-harmony.rst @@ -1,11 +1,14 @@ -.. 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: diff --git a/documentation/source/quick-start/supported-boards.rst b/documentation/source/quick-start/supported-boards.rst deleted file mode 100644 index 0f330e335705f2354b3970a6af886bff196703ff..0000000000000000000000000000000000000000 --- a/documentation/source/quick-start/supported-boards.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. include:: ../definitions.rst - -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>`_ - -For more information on supported boards and instructions to use them, see https://git.ostc-eu.org/OSTC/OHOS/docs/supported-boards. diff --git a/documentation/source/readme/Readme-EN.rst b/documentation/source/readme/Readme.rst similarity index 100% rename from documentation/source/readme/Readme-EN.rst rename to documentation/source/readme/Readme.rst diff --git a/documentation/source/quick-start/96b-Avenger.rst b/documentation/source/supported-boards/96b-Avenger.rst similarity index 99% rename from documentation/source/quick-start/96b-Avenger.rst rename to documentation/source/supported-boards/96b-Avenger.rst index 47cda16f52a82e201922674092b1cb5167cd5a29..1e4bc37c67df182a3f5f8f35188e318d5c7c9c89 100644 --- a/documentation/source/quick-start/96b-Avenger.rst +++ b/documentation/source/supported-boards/96b-Avenger.rst @@ -1,3 +1,5 @@ +.. _avenger96: + .. include:: ../definitions.rst 96Boards Avenger96 diff --git a/documentation/source/quick-start/96b-nitrogen.rst b/documentation/source/supported-boards/96b-nitrogen.rst similarity index 99% rename from documentation/source/quick-start/96b-nitrogen.rst rename to documentation/source/supported-boards/96b-nitrogen.rst index c6d2e08252357684f6acaa43bc12034197a97afd..27e2b701e36f25486dfd13537200eadaf5bf22b6 100644 --- a/documentation/source/quick-start/96b-nitrogen.rst +++ b/documentation/source/supported-boards/96b-nitrogen.rst @@ -1,3 +1,5 @@ +.. _nitogen: + .. include:: ../definitions.rst 96Boards Nitrogen diff --git a/documentation/source/supported-boards/Readme.rst b/documentation/source/supported-boards/Readme.rst new file mode 100644 index 0000000000000000000000000000000000000000..8a1059298873c976217eadaceb0bff7a1f70fdfb --- /dev/null +++ b/documentation/source/supported-boards/Readme.rst @@ -0,0 +1,18 @@ +.. supported-boards: + +.. include:: ../definitions.rst + +Supported Boards +################ + +Harmony OS supports the following boards: + +.. 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. + + diff --git a/readme.rst b/readme.rst index 7cfec47b036e560b45b17923054da21ddcefe620..1745bc2c7498ec48387913ca3f0f56445a5fafe7 100644 --- a/readme.rst +++ b/readme.rst @@ -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>`_.