diff --git a/index.rst b/index.rst
index 455e2392d69d4098bc9953d692387f18d86e8310..0741dd66c8bb35923eff84e3d98ec94b8bf80165 100644
--- a/index.rst
+++ b/index.rst
@@ -10,7 +10,7 @@ Welcome to |main_project_name| documentation!
:maxdepth: 1
overview/README
- quick-start/build-open-harmony
+ quick-start/README
supported-boards/README
readme/README
term/glossary
diff --git a/quick-start/README.rst b/quick-start/README.rst
new file mode 100644
index 0000000000000000000000000000000000000000..baaf56c6da369f1b6d121a31df8f82e465b6db5f
--- /dev/null
+++ b/quick-start/README.rst
@@ -0,0 +1,16 @@
+.. include:: ../definitions.rst
+
+Getting Started Guide
+#####################
+
+|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 :ref:`supported-boards`. The configuration is set with certain default values which can be customized as per your preference.
+
+.. toctree::
+ :maxdepth: 2
+
+ downloading-tools-and-sourcecode
+ build-open-harmony
+ linux-flavour
+ zephyr-flavour
+ freeRTOS-flavour
+
diff --git a/quick-start/build-open-harmony.rst b/quick-start/build-open-harmony.rst
index f9be3d5086ce9446000866e4558125e1c87cd0c3..d139e49553b1bcb6e892d4e227fe9924a8cb1c2d 100644
--- a/quick-start/build-open-harmony.rst
+++ b/quick-start/build-open-harmony.rst
@@ -2,13 +2,10 @@
.. include:: ../definitions.rst
-Getting Started
-###############
-
-|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.
+Building and Running |main_project_name| image
+##############################################
-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.
+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.
.. contents::
:depth: 3
@@ -19,7 +16,7 @@ This topic provides an overview of meta-ohos architecture, tools, and source cod
:align: center
:alt: meta-ohos overview
-.. _downloading-tools:
+.. _prerequisites:
Prerequisites
*************
@@ -31,91 +28,10 @@ Prerequisites
* Install Python latest version
* Install **Ubuntu 20.04 LTS** version
-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
-
- $ sudo add-apt-repository ppa:zyga/oh-tools
- $ sudo apt-get update
- $ sudo apt-get install git-repo
-
-.. _downloading-source-code:
-
-Downloading Source Code
-***********************
-
-Once git-repo has been installed, you can clone the necessary repositories.
-
-**For OHOS User**
-
-If you are a user and wants to build your product on top of OHOS, then clone the ‘stable’ branch by executing the following commands:
-
- .. code-block:: console
-
- $ mkdir ohos; cd ohos
- $ repo init -u https://git.ostc-eu.org/OSTC/manifest.git -b stable
- $ repo sync --no-clone-bundle
-**For OHOS Developer**
-
-If you are a developer and wants to contribute to OHOS, then clone the ‘develop’ branch by executing the following commands:
-
- .. code-block:: console
-
- $ mkdir ohos; cd ohos
- $ repo init -u https://git.ostc-eu.org/OSTC/manifest.git -b develop -m develop.xml
- $ repo sync
-
-The preceding commands creates the following directory structure (layers):
-
-.. code-block:: console
-
- ./ohos/
- └─ sources
- ├── meta-freertos
- ├── meta-ohos
- ├── meta-openembedded
- ├── meta-zephyr
- ├── <various yocto layers>
- └── poky
-
-To verify the created directory structure (layers), run the following command:
-
-.. code-block:: console
-
- $ cd sources && ls -l
-
-Navigate to *ohos* directory by running the following command:
-
-.. code-block:: console
-
- $ cd ..
-
-.. list-table:: meta-ohos
- :widths: auto
- :header-rows: 1
-
- * - Placeholder Name
- - Description
- * - meta-freertos
- - FreeRTOS distro layer compatible with OpenEmbedded.
- * - meta-ohos
- - A set of meta-layers for building Open Harmony OS.
- * - meta-openembedded
- - Layers, recipes, packages, and source material for developing a image.
- * - meta-zephyr
- - Layers required for building Zephyr images.
- * - <various yocto layers>
- - Layers required to build yacto images.
- * - poky
- - Layers required to build customised embedded device images.
-
.. _building-image:
-Building and Running |main_project_name| image
-**********************************************
+Procedure
+***********
|main_project_name| can be hosted on top of a variety of kernels. Currently supported kernels (a.k.a. OHOS flavours) are Linux, Zephyr, and FreeRTOS (experimental).
@@ -136,200 +52,10 @@ You can use the following syntax to build the OHOS flavour of your choice.
$ MACHINE=<target_machine> bitbake <image-name>
-.. _linux_flavour:
-
-OHOS Linux flavour
-==================
-
-OHOS Linux flavour is based on `poky` distribution. Current version supports the following images and machines:
-
-**Supported images:**
-
-.. list-table:: Supported images
- :widths: auto
- :header-rows: 1
-
- * - Image Name
- - Size
- - Description
- * - openharmony-image-base
- - Approximate 100-200 MB
- - OpenHarmony image including the base OS software stack
- * - openharmony-image-extra
- - Approximate 100-200 MB
- - OpenHarmony Wayland image including the base OS software stack
-
-**Supported machines:**
-
-.. list-table:: Supported machines
- :widths: auto
- :header-rows: 1
-
- * - Machine Name
- - Details
- * - qemux86-64 (default)
- - Emulator
- * - qemux86
- - Emulator
- * - qemuarm
- - Emulator
- * - qemuarm64
- - Emulator
- * - seco-intel-b68 (SECO SBC-B68)
- - `Details <https://www.seco.com/en/products/sbc-b68-enuc>`_
- * - stm32mp1-av96 (96Boards Avenger96)
- - `Details <https://www.96boards.org/product/avenger96/>`_
- * - seco-imx8mm-c61 (SECO SBC-C61)
- - `Details <https://www.seco.com/en/products/sbc-c61>`_
-
-
-**Step1:** You can select the preferred image and machine to build your image. For example, for **qemux86-64** machine and **openharmony-image-base** image, execute:
-
-.. code-block:: console
-
- $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux-qemux86-64
- $ bitbake openharmony-image-base
-
-**Step2:** Test the image built by executing the following test command considering **qemux86-64** machine as an example:
-
-.. code-block:: console
-
- $ runqemu qemux86-64 qemuparams="-nographic"
-
-**Result:** After successful bootup, you should see the following:
-
-.. code-block:: console
-
- $ qemux86-64 login:
-
-The default login as root without a password. After login you should see the following prompt:
-
-.. code-block:: console
-
- $ root@qemux86-64:~#
-
-To exit qemu, you can either shut down the system:
-
-.. code-block:: console
-
- $ root@qemux86:~# poweroff -f
-
-or close qemu using key combination:
-
-**Ctrl-A** followed by 'x'
-
-.. _zephyr_flavour:
-
-OHOS Zephyr flavour
-===================
-
-OHOS Zephyr flavour is based on zephyr distribution and supports the following images or machines:
-
-**Supported images:**
-
-* Zephyr comes with multiple sample applications, for more details on available recipes, see `sources/meta-zephyr/recipes-kernel/zephyr-kernel/`. You can add your own recipes to use sample applications provided with Zephyr. For more details, `Click <https://github.com/zephyrproject-rtos/zephyr/tree/master/samples>`_.
-
-**Supported machines:**
-
-.. list-table:: Supported machines
- :widths: auto
- :header-rows: 1
-
- * - Machine Name
- - Details
- * - qemu-x86 (default)
- - Emulator
- * - qemu-cortex-m3
- - Emulator
- * - 96b-nitrogen (96Boards Nitrogen)
- - `Details <https://www.96boards.org/product/nitrogen/>`_
- * - 96b-avenger96 (96Boards Avenger96)
- - `Details <https://www.96boards.org/product/avenger96/>`_
-
-
-**Step1:** You can select the preferred image and machine to build your image. For example, for **qemu-x86* machine and **zephyr-philosophers** image, execute:
-
-.. code-block:: console
-
- $ TEMPLATECONF=../sources/meta-ohos/flavours/zephyr . ./sources/poky/oe-init-build-env build-ohos-zephyr-qemu-x86
- $ bitbake zephyr-philosophers
-
-**Step2:** Test the image built by executing the following test command considering **qemu-x86** machine as an example:
-
-.. code-block:: console
-
- $ runqemu qemu-x86
-
-**Result:** After successful bootup, you should see the following:
-
-.. code-block:: console
-
- Booting from ROM..*** Booting Zephyr OS build zephyr-v2.4.0 ***
- Philosopher 0 [P: 3] THINKING [ 300 ms ]
- Philosopher 1 [P: 2] EATING [ 575 ms ]
- Philosopher 2 [P: 1] STARVING
- Philosopher 3 [P: 0] EATING [ 525 ms ]
- Philosopher 4 [C: -1] THINKING [ 475 ms ]
-
-To exit qemu, use key combination:
-
-**Ctrl-A** followed by 'x'
-
-.. _freertos_flavour:
-
-OHOS FreeRTOS flavour
-=====================
-
-OHOS FreeRTOS flavour is based on `freertos` distribution and supports the following images and smachines:
-
-**Supported images:**
-
-* freertos-demo
-
-
-**Supported machines:**
-
-.. list-table:: Supported machines
- :widths: auto
- :header-rows: 1
-
- * - Machine Name
- - Details
- * - qemuarmv5
- - Emulator
-
-
-**Step1:** You can select the preferred image and machine to build your image. For example, for **qemuarmv5** machine and **freertos-demo** image, execute:
-
-.. code-block:: console
-
- $ TEMPLATECONF=../sources/meta-ohos/flavours/freertos . ./sources/poky/oe-init-build-env build-ohos-freertos-qemuarmv5
- $ bitbake freertos-demo
-
-**Step2:** Test the image built by executing the following test command considering qemuarmv5 machine as an example:
-
-.. code-block:: console
-
- $ runqemu qemuarmv5
-
-**Result:** After successful bootup, you should see the following:
-
-.. code-block:: console
-
- ###### - FreeRTOS sample application - ######
-
- A text may be entered using a keyboard.
- It will be displayed when 'Enter' is pressed.
- Periodic task 10 secs
- Waiting For Notification - Blocked...
- Task1
- Task1
- You entered: "HelloFreeRTOS"
- Unblocked
- Notification Received
- Waiting For Notification - Blocked...
+Currently, |main_project_name| supports Linux, Zephyr, and FreeRTOS kernels. For more information on buidling an image with different OHOS flavours, see the following topics:
-To exit qemu, use key combination:
+* :ref:`FreeRTOS flavour <freertos_flavour>`
+* :ref:`Zephyr flavour <zephyr_flavour>`
+* :ref:`Linux flavour <linux_flavour>`
-**Ctrl-A** followed by 'x'
diff --git a/quick-start/downloading-tools-and-sourcecode.rst b/quick-start/downloading-tools-and-sourcecode.rst
new file mode 100644
index 0000000000000000000000000000000000000000..ea21f2422e31bafd51ce3204137aa4e379dfe2a4
--- /dev/null
+++ b/quick-start/downloading-tools-and-sourcecode.rst
@@ -0,0 +1,88 @@
+.. include:: ../definitions.rst
+
+Downloading Tools and Source Code
+#################################
+
+.. _downloading-tools:
+
+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
+
+ $ sudo add-apt-repository ppa:zyga/oh-tools
+ $ sudo apt-get update
+ $ sudo apt-get install git-repo
+
+.. _downloading-source-code:
+
+Downloading Source Code
+***********************
+
+Once git-repo has been installed, you can clone the necessary repositories.
+
+**For OHOS User**
+
+If you are a user and wants to build your product on top of OHOS, then clone the ‘stable’ branch by executing the following commands:
+
+.. code-block:: console
+
+ $ mkdir ohos; cd ohos
+ $ repo init -u https://git.ostc-eu.org/OSTC/manifest.git -b stable
+ $ repo sync --no-clone-bundle
+
+**For OHOS Developer**
+
+If you are a developer and wants to contribute to OHOS, then clone the ‘develop’ branch by executing the following commands:
+
+.. code-block:: console
+
+ $ mkdir ohos; cd ohos
+ $ repo init -u https://git.ostc-eu.org/OSTC/manifest.git -b develop -m develop.xml
+ $ repo sync --no-clone-bundle
+
+The preceding commands creates the following directory structure (layers):
+
+.. code-block:: console
+
+ ./ohos/
+ └─ sources
+ ├── meta-freertos
+ ├── meta-ohos
+ ├── meta-openembedded
+ ├── meta-zephyr
+ ├── <various yocto layers>
+ └── poky
+
+To verify the created directory structure (layers), run the following command:
+
+.. code-block:: console
+
+ $ cd sources && ls -l
+
+Navigate to *ohos* directory by running the following command:
+
+.. code-block:: console
+
+ $ cd ..
+
+.. list-table:: meta-ohos
+ :widths: auto
+ :header-rows: 1
+
+ * - Placeholder Name
+ - Description
+ * - meta-freertos
+ - FreeRTOS distro layer compatible with OpenEmbedded.
+ * - meta-ohos
+ - A set of meta-layers for building Open Harmony OS.
+ * - meta-openembedded
+ - Layers, recipes, packages, and source material for developing a image.
+ * - meta-zephyr
+ - Layers required for building Zephyr images.
+ * - <various yocto layers>
+ - Layers required to build yacto images.
+ * - poky
+ - Layers required to build customised embedded device images.
diff --git a/quick-start/freeRTOS-flavour.rst b/quick-start/freeRTOS-flavour.rst
new file mode 100644
index 0000000000000000000000000000000000000000..8eeb852102f5c664a435ae2ab5154cdf33da462e
--- /dev/null
+++ b/quick-start/freeRTOS-flavour.rst
@@ -0,0 +1,80 @@
+.. _freertos_flavour:
+
+.. include:: ../definitions.rst
+
+FreeRTOS flavour
+################
+
+OHOS FreeRTOS flavour is designed to be simple and easy to use. It is based on `freertos` distribution.
+
+For getting started with |main_project_name|, *Downloading Tools* and *Source Code* perform the procedure in :ref:`Getting Started <BuildOpenharmony>`.
+
+OHOS FreeRTOS flavour supports the following images and machines:
+
+Supported images
+****************
+
+* freertos-demo
+
+Supported machines
+******************
+
+.. list-table:: Supported machines
+ :widths: auto
+ :header-rows: 1
+
+ * - Machine Name
+ - Details
+ * - qemuarmv5
+ - Emulator
+
+Prerequisites
+*************
+* All the bitbake commands must be executed in your localhost as a normal user instead of a root user.
+* Install the following build dependencies packages for bitbake:
+
+ * chrpath
+ * gawk
+* Install Python latest version
+* Install **Ubuntu 20.04 LTS** version
+
+Procedure
+*********
+
+Perform the following steps to build the image on the supported machine:
+
+1. Select the preferred image and machine to build your image. For example, for **qemuarmv5** machine and **freertos-demo** image, execute:
+
+.. code-block:: console
+
+ $ TEMPLATECONF=../sources/meta-ohos/flavours/freertos . ./sources/poky/oe-init-build-env build-ohos-freertos-qemuarmv5
+ $ bitbake freertos-demo
+
+2. Test the image built by executing the following test command considering qemuarmv5 machine as an example:
+
+.. code-block:: console
+
+ $ runqemu qemuarmv5
+
+Result
+******
+
+After successful bootup, you should see the following:
+
+.. code-block:: console
+
+ ###### - FreeRTOS sample application - ######
+
+ A text may be entered using a keyboard.
+ It will be displayed when 'Enter' is pressed.
+
+ Periodic task 10 secs
+ Waiting For Notification - Blocked...
+ Task1
+ Task1
+ You entered: "HelloFreeRTOS"
+ Unblocked
+ Notification Received
+ Waiting For Notification - Blocked...
+
+To exit qemu, use key combination: **Ctrl-A** followed by 'x'.
diff --git a/quick-start/linux-flavour.rst b/quick-start/linux-flavour.rst
new file mode 100644
index 0000000000000000000000000000000000000000..70158af68610ada59a3287b047f7d4b53cfe89a1
--- /dev/null
+++ b/quick-start/linux-flavour.rst
@@ -0,0 +1,103 @@
+.. _linux_flavour:
+
+.. include:: ../definitions.rst
+
+Linux flavour
+#############
+
+OHOS Linux flavour is based on `poky` distribution.
+
+For getting started with |main_project_name|, *Downloading Tools* and *Source Code* perform the procedure in :ref:`Getting Started <BuildOpenharmony>`.
+
+OHOS Linux flavour supports the following images and machines:
+
+Supported images
+****************
+.. list-table:: Supported images
+ :widths: auto
+ :header-rows: 1
+
+ * - Image Name
+ - Size
+ - Description
+ * - openharmony-image-base
+ - Approximate 100-200 MB
+ - OpenHarmony image including the base OS software stack
+ * - openharmony-image-extra
+ - Approximate 100-200 MB
+ - OpenHarmony Wayland image including the base OS software stack
+
+Supported machines
+******************
+
+.. list-table:: Supported machines
+ :widths: auto
+ :header-rows: 1
+
+ * - Machine Name
+ - Details
+ * - qemux86-64 (default)
+ - Emulator
+ * - qemux86
+ - Emulator
+ * - qemuarm
+ - Emulator
+ * - qemuarm64
+ - Emulator
+ * - seco-intel-b68 (SECO SBC-B68)
+ - `Details <https://www.seco.com/en/products/sbc-b68-enuc>`_
+ * - stm32mp1-av96 (96Boards Avenger96)
+ - `Details <https://www.96boards.org/product/avenger96/>`_
+ * - seco-imx8mm-c61 (SECO SBC-C61)
+ - `Details <https://www.seco.com/en/products/sbc-c61>`_
+
+
+Prerequisites
+*************
+* All the bitbake commands must be executed in your localhost as a normal user instead of a root user.
+* Install the following build dependencies packages for bitbake:
+
+ * chrpath
+ * gawk
+* Install Python latest version
+* Install **Ubuntu 20.04 LTS** version
+
+Procedure
+*********
+
+1. You can select the preferred image and machine to build your image. For example, for **qemux86-64** machine and **openharmony-image-base** image, execute:
+
+.. code-block:: console
+
+ $ TEMPLATECONF=../sources/meta-ohos/flavours/linux . ./sources/poky/oe-init-build-env build-ohos-linux-qemux86-64
+ $ bitbake openharmony-image-base
+
+2. Test the image built by executing the following test command considering **qemux86-64** machine as an example:
+
+.. code-block:: console
+
+ $ runqemu qemux86-64 qemuparams="-nographic"
+
+Result
+******
+
+* After successful bootup, you should see the following:
+
+.. code-block:: console
+
+ $ qemux86-64 login:
+
+* The default login as root without a password. After login you should see the following prompt:
+
+.. code-block:: console
+
+ $ root@qemux86-64:~#
+
+
+* To exit qemu, you can either shut down the system using the following command or
+
+.. code-block:: console
+
+ $ root@qemux86:~# poweroff -f
+
+or close qemu using key combination: **Ctrl-A** followed by 'x'.
diff --git a/quick-start/zephyr-flavour.rst b/quick-start/zephyr-flavour.rst
new file mode 100644
index 0000000000000000000000000000000000000000..9d7416c9c66ef9c8c98dfa61358cb55b3260542c
--- /dev/null
+++ b/quick-start/zephyr-flavour.rst
@@ -0,0 +1,79 @@
+.. _zephyr_flavour:
+
+.. include:: ../definitions.rst
+
+Zephyr flavour
+##############
+
+OHOS Zephyr flavour is based on zephyr distribution.
+
+For getting started with |main_project_name|, *Downloading Tools* and *Source Code* perform the procedure in :ref:`Getting Started <BuildOpenharmony>`.
+
+OHOS Zephyr flavour supports the following images or machines:
+
+Supported images
+****************
+
+* Zephyr comes with multiple sample applications, for more details on available recipes, see `sources/meta-zephyr/recipes-kernel/zephyr-kernel/`. You can add your own recipes to use sample applications provided with Zephyr. For more details, `Click <https://github.com/zephyrproject-rtos/zephyr/tree/master/samples>`_.
+
+Supported machines
+******************
+
+.. list-table:: Supported machines
+ :widths: auto
+ :header-rows: 1
+
+ * - Machine Name
+ - Details
+ * - qemu-x86 (default)
+ - Emulator
+ * - qemu-cortex-m3
+ - Emulator
+ * - 96b-nitrogen (96Boards Nitrogen)
+ - `Details <https://www.96boards.org/product/nitrogen/>`_
+ * - 96b-avenger96 (96Boards Avenger96)
+ - `Details <https://www.96boards.org/product/avenger96/>`_
+
+Prerequisites
+*************
+* All the bitbake commands must be executed in your localhost as a normal user instead of a root user.
+* Install the following build dependencies packages for bitbake:
+
+ * chrpath
+ * gawk
+* Install Python latest version
+* Install **Ubuntu 20.04 LTS** version
+
+Procedure
+*********
+
+Perform the following steps to build the image on the supported machine:
+
+1. You can select the preferred image and machine to build your image. For example, for **qemu-x86* machine and **zephyr-philosophers** image, execute:
+
+.. code-block:: console
+
+ $ TEMPLATECONF=../sources/meta-ohos/flavours/zephyr . ./sources/poky/oe-init-build-env build-ohos-zephyr-qemu-x86
+ $ bitbake zephyr-philosophers
+
+2. Test the image built by executing the following test command considering **qemu-x86** machine as an example:
+
+.. code-block:: console
+
+ $ runqemu qemu-x86
+
+Result
+******
+
+After successful bootup, you should see the following:
+
+.. code-block:: console
+
+ Booting from ROM..*** Booting Zephyr OS build zephyr-v2.4.0 ***
+ Philosopher 0 [P: 3] THINKING [ 300 ms ]
+ Philosopher 1 [P: 2] EATING [ 575 ms ]
+ Philosopher 2 [P: 1] STARVING
+ Philosopher 3 [P: 0] EATING [ 525 ms ]
+ Philosopher 4 [C: -1] THINKING [ 475 ms ]
+
+To exit qemu, use key combination: **Ctrl-A** followed by 'x'.
diff --git a/supported-boards/README.rst b/supported-boards/README.rst
index f5874d2d6764f62d3ff2e29d949e93a75c5d8766..b93ea2c238d194484a63506beb65aa3e94163ddb 100644
--- a/supported-boards/README.rst
+++ b/supported-boards/README.rst
@@ -15,12 +15,6 @@ Supported Boards
seco-intel-b68
seco-imx8mm-c61
-|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. |main_project_name| uses notion of kernel specific flavours with predefined IMAGES and MACHINES:
-
-* :ref:`linux_flavour`
-* :ref:`zephyr_flavour`
-* :ref:`freertos_flavour`
-
For more detailed information of kernel specific flavours, see :ref:`Getting Started <BuildOpenharmony>`.
.. note::