Skip to content
Snippets Groups Projects
Commit 7a70cdf2 authored by Stefan Schmidt's avatar Stefan Schmidt
Browse files

Introduction of release notes for Aladeen release


Signed-off-by: default avatarSebastian Serewa <sebastian.serewa@huawei.com>
Signed-off-by: Andrei Gherzan's avatarAndrei Gherzan <andrei.gherzan@huawei.com>
Signed-off-by: default avatarStefan Schmidt <stefan.schmidt@huawei.com>
parent 493f3b34
No related branches found
Tags v0.1.0
No related merge requests found
......@@ -25,8 +25,8 @@ project = 'OpenHarmony'
copyright = '2021'
author = 'OSTC'
# The full version, including alpha/beta/rc tags
release = '0.0'
version = '0.1.0'
release = version
# -- General configuration ---------------------------------------------------
......
......@@ -2,5 +2,4 @@
..
.. SPDX-License-Identifier: CC-BY-4.0
.. |main_project_name| replace:: OpenHarmony
.. |main_project_version| replace:: 0.1.0-rc1
.. |contact_info| replace:: <TBD>
......@@ -22,7 +22,7 @@ daily life.
.. toctree::
:maxdepth: 2
overview/index
meta-ohos/index
contributing/index
......@@ -32,3 +32,4 @@ daily life.
ip-policy/index
code-of-conduct
community-chat-platform
releases/index
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../../../definitions.rst
Aladeen - 0.1.0
###############
About
*****
The objective of this document is to provide basic introductory information
about included functionalities, known issues, instructions guidance for
the Aladeen release of the |main_project_name| project.
The |main_project_name| project is meant to serve as a solid base foundation
for products. It is not a standalone product itelf, but rather a starting
project for other projects and products.
Scope
*****
**Release codename**: Aladeen
**Release version**: 0.1.0
**Release timeframe**: 2020/11/15 .. 2021/04/12
The objectives of the release
-----------------------------
The purpose of this release is to provide and donate the initial version
of |main_project_name| to the Eclipse foundation. This release serves as
a solid foundation upon which |main_project_name| Eclipse working group members
can further develop |main_project_name| as a ubiquitous operating system for
all consumer electronic devices.
This release is mostly developed by Huawei OSTC, in the cooperation with
the initial set of partners. It supports the creation of the |main_project_name|
working group and as such has to meet all high quality and IP compliance
standards steming from the Eclipse Foundation.
The MVP (Minimum Viable Product) approach is applied. It means that
the preliminary set of high quality functionalities is defined, which the project
will strive to deliver. In the near future, we expect it to enable easy
and rapid development of new high quality products.
The key goals of this first release are:
- Quality
- Stability
- Long term viability
More details on the |main_project_name| goals can be found in the
:doc:`/overview/openharmony-vision` document.
Supported hardware platforms
----------------------------
+--------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
| Board (chipset) | Supported kernels | Board documentation |
+======================================================================================================================================+=====================+==================================+
| `Nitrogen (nRF52832 - Cortex-M4) <https://docs.zephyrproject.org/latest/boards/arm/96b_nitrogen/doc/index.html#boards-nitrogen>`__ | Zephyr | :ref:`SupportedBoardNitrogen` |
+--------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
| `Avenger96 (STM32 - Cortex-A7 & Cortex-M4) <https://docs.zephyrproject.org/latest/boards/arm/96b_avenger96/doc/index.html>`__ | Linux & Zephyr | :ref:`SupportedBoardAvenger96` |
+--------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
| `SBC-C61 (NXP i.MX 8M - Coretex-A53 & Cortex M4) <https://pdf.directindustry.com/pdf/seco-spa/sbc-c61/54043-913344.html>`__ | Linux | :ref:`SupportedBoardSecoC61` |
+--------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
| `SBC-B68-eNUC (Intel x86) <https://pdf.directindustry.com/pdf/seco-spa/sbc-b68-enuc/54043-913350.html>`__ | Linux | :ref:`SupportedBoardSecoB68` |
+--------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
The list of software features included
--------------------------------------
+------------------------------------------------------------------+--------------------------+
| **Functionalities** | **Area** |
+==================================================================+==========================+
| nRF SoC/platform supported in Zephyr | Board Support Package |
+------------------------------------------------------------------+--------------------------+
| stm32 SoC/platform supported in Zephyr | Board Support Package |
+------------------------------------------------------------------+--------------------------+
| Network applications: MQTT protocol supported in OHOS | Connectivity |
+------------------------------------------------------------------+--------------------------+
| Connectivity: open-source USB stack supported in OHOS | Connectivity |
+------------------------------------------------------------------+--------------------------+
| Connectivity: open-source BLE stack supported in Zephyr, Linux | Connectivity |
+------------------------------------------------------------------+--------------------------+
| Provide bitbake support for OHOS | Build tools |
+------------------------------------------------------------------+--------------------------+
| Adding SPDX and licenses manifest auto generation | FOSS compliance |
+------------------------------------------------------------------+--------------------------+
| Linux Seco SBC-C61 BSP | Board Support Package |
+------------------------------------------------------------------+--------------------------+
| Linux Seco SBC-B68-eNUC BSP | Board Support Packages |
+------------------------------------------------------------------+--------------------------+
| Setup Environment & Tools for EUIncubator | Documentation |
+------------------------------------------------------------------+--------------------------+
| OpenHarmony Documentation Gaps Correction | Documentation |
+------------------------------------------------------------------+--------------------------+
| OpenHarmony Documentation Process established | Documentation |
+------------------------------------------------------------------+--------------------------+
| Connectivity: open-source Ethernet stack supported in OHOS | Connectivity |
+------------------------------------------------------------------+--------------------------+
Test report
-----------
Not available for this release.
Installation
************
:ref:`Quick Build <OpenHarmonyQuickBuild>` provides an example of how to build
the |main_project_name| project for a supported target. Visit the
:ref:`Hardware Support <HardwareSupport>` section for instructions on how to
build for other supported targets.
Visit :ref:`setting up a repo workspace <RepoWorkspace>` for general instruction
while using the release tag for the repo init commands as follows:
.. code-block:: console
repo init -u https://git.ostc-eu.org/OSTC/OHOS/manifest.git -b refs/tags/v0.1.0
Known issues
------------
The Avenger96 target (stm32mp1-av96) does not ship with firmware files for Bluetooth,
Wifi and the image processor by default. We are working on a solution to re-distribute
them during the normal image builds for this board.
Source code available
---------------------
For more details on our repo structure, see:
`OSTC group at GitLab <https://git.ostc-eu.org/OSTC>`__ document
Devops infrastructure
*********************
To learn more about our approach to CI (Continuous Integration) strategy used for this release, please see:
:doc:`/ci/index` document
Testing
-------
For more details please refer to:
:doc:`/ci/xts-acts` document
Contributions
*************
If you are a developer eager to know more details about |main_project_name| or
just an enthusiast with a patch proposal, you are welcome to participate to our |main_project_name|
ecosystem development. To do so, please sign-up using the process described below:
:doc:`/contributing/index` document
License
*******
Project manifest as well as project-specific meta-layers, recipes and
software packages are, unless specified otherwise, published under
Apache 2.0 license. The whole operating system built by users from the
project manifest is an aggregate comprised of many third-party components
or component groups, each subject to its own license conditions.
Official project release includes only the project manifest as well as
project-specific meta-layers, recipes.
Any reference binary image, build cache and any other build
artifacts are distributed as a convenience only and are not part of the
release itself.
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: ../definitions.rst
Releases
########
This section contains information related to releases of |main_project_name|.
.. toctree::
:maxdepth: 1
aladeen/0.1.0/release_notes
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