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

Main Readme update

parent 746100d0
No related branches found
No related tags found
No related merge requests found
......@@ -17,7 +17,7 @@
# -- Project information -----------------------------------------------------
project = 'Harmony-OS'
project = 'OpenHarmony'
copyright = '2021'
author = 'OSTC'
......
......@@ -3,6 +3,8 @@
Welcome to |main_project_name| documentation!
#############################################
|main_project_name| is an open-source project launched by Open Source Technology Center (OSTC). |main_project_name| is a distributed operating system (OS) that is intended to address all conceivable usage scenarios. |main_project_name| is an open-source version of HarmonyOS. HarmonyOS is a future-proof distributed operating system open to you as part of the initiatives for the all-scenario strategy, adaptable to a mobile office, fitness and health, social communication, and media entertainment, and so on. Unlike a legacy operating system that runs on a standalone device, HarmonyOS is built on a distributed architecture designed based on a set of system capabilities. It runs on a wide range of device forms, including smartphones, wearables, tablets, PCs, smart TVs, AI speakers, head units, earphones, and AR/VR glasses.
.. toctree::
:maxdepth: 1
......
......@@ -10,6 +10,9 @@ Getting Started
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.
.. toctree::
:depth: 2
**Figure 1 meta-ohos overview**
......@@ -17,7 +20,7 @@ This topic provides an overview of meta-ohos architecture, tools, and source cod
:align: center
:alt: meta-ohos overview
.. _tool-acquisition:
.. _downloading-tools:
Downloading Tools
***********************
......@@ -30,7 +33,7 @@ To start with, you need to install git-repo by executing the following command.
$ sudo apt-get update
$ sudo apt-get install git-repo
.. _source-code-acquisition:
.. _downloading-source-code:
Downloading Source Code
********************************
......
......@@ -24,18 +24,5 @@ If you have never subscribed to a mail list before, follow the steps below:
Email Address Introduction Description
======================= ============================= ================================================================================================
|contact_info| Public Mailbox Public mailbox of the OpenHarmony community.
You can send emails to this mailbox to sign the Contributor License Agreement (CLA).
dev@openharmony.io Development mail list OpenHarmony community development discussion group.
Any topics related to community development can be discussed here. Any one can `subscribe <https://lists.openatom.io/postorius/lists/dev.openharmony.io/>`_ to it.
cicd@openharmony.io CI mail list The OpenHarmony community CI/CD builds a mail list that any developer can `subscribe <https://lists.openatom.io/postorius/lists/cicd.openharmony.io/>`_ to.
pmc@openharmony.io PMC mail list Mail list for PMC discussion. It can be `subscribed <https://lists.openatom.io/postorius/lists/pmc.openharmony.io/>`_ to by PMC members
scy@openharmony.io Mail list for security issues Email address for you to report OpenHarmony security issues.
scy-priv@openharmony.io Security group mail list The security group members can `subscribe <https://lists.openatom.io/postorius/lists/scy-priv.openharmony.io/>`_ to this email list to discuss security issues.
======================= ============================= ================================================================================================
How Do I Send Emails to a Mail List?
************************************
To send an email to a specified mail list, send your email to the address listed in the table above.
In this way, all community members in this mail list will receive your email.
======================= ============================= ================================================================================================
......@@ -20,8 +20,3 @@ Contribution Workflow
*********************
For details, see `Contribution Process <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contribution%20Process.rst>`_.
Security Issue Disclosure
*************************
* Security handling procedure
* Security disclosure information
Welcome to Open Harmony
########################
OpenHarmony is an open-source project launched by the OpenAtom Foundation and serves as an open-source, distributed operating system (OS) that is intended to address all conceivable usage scenarios. OpenHarmony is an open-source version of HarmonyOS. HarmonyOS is a future-proof distributed operating system open to you as part of the initiatives for the all-scenario strategy, adaptable to a mobile office, fitness and health, social communication, and media entertainment, and so on. Unlike a legacy operating system that runs on a standalone device, HarmonyOS is built on a distributed architecture designed based on a set of system capabilities. It is able to run on a wide range of device forms, including smartphones, wearables, tablets, PCs, smart TVs, AI speakers, head units, earphones, and AR/VR glasses.
OpenHarmony is an open-source project launched by Huawei. OpenHarmony is a future-proof distributed operating system open to you as part of the initiatives for the all-scenario strategy, adaptable to a mobile office, fitness and health, social communication, and media entertainment, and so on. Unlike a legacy Operating system that runs on a standalone device, OpenHarmony is built on a distributed architecture design based on a set of system capabilities. It will run on a wide range of device forms, including smartphones, wearables, tablets, PCs, smart TVs, AI speakers, head units, earphones, and AR/VR glasses.
Motivation
**********
The traditional OSs are limited to a specific type of device, OpenHarmony provides distributed features that are compatible with a wide range of different devices. The first version supports devices with 128 KB to 128 MB of memory. Join us as we keep updating OpenHarmony versions. For device developers, OpenHarmony utilizes a component-based design to tailor its features to better suit specific devices, based on each device's capabilities and service characteristics. OpenHarmony can run on devices with limited resources and wearables with hundreds of KB of memory, as well as more powerful devices, such as smart home cameras and dashcams with hundreds of MB of memory.
*************
The traditional Operating Systems are limited to a specific type of device, whereas OpenHarmony is a device independent platform. OpenHarmony provides distributed features that are compatible with a wide range of different devices. The initial version supports devices with 128 KB to 128 MB of memory and the subsequent versions will support higher memory and advanced devices. OpenHarmony will be developed as part of **Eclipse Working Group** and we welcome you to join us in this journey of improving one of the advanced device-independent operating system platform. For device developers, OpenHarmony utilizes a component-based design to tailor its features to better suit specific devices, based on each device's capabilities and service characteristics. OpenHarmony can run on devices with limited resources and wearables with hundreds of KB of memory, as well as more powerful devices, such as smart home cameras and dashcams with hundreds of MB of memory.
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>`_
* `Supported Boards <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/MainReadme/documentation/source/supported-boards/Readme.rst>`_
For latest OpenHarmony Documentation, `Click <https://openharmony-documentation.readthedocs.io>`_.
For the latest OpenHarmony Documentation, `Click <https://openharmony-documentation.readthedocs.io>`_.
Start Contributing
******************
OpenHarmony is an Open Source Community and encourages everyone in the community to submit the patches directly to the project. You can either contribute to the code or documentation.
Get Source Code and Tools
*********************************
The first thing to do is to get the required tools and source code for the development and contribution purpose. Here are the links to download the tools and source code. Once you finish downloading, you can refer to the Contribution Guidelines for more details on the process and style guides used.
* `Contributing to the Code <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contributing%20to%20the%20Code.rst>`_
* `Contributing to the Documentation <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contributing%20to%20the%20Documentation.rst>`_
* `Downloading Tools <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/quick-start/build-open-harmony.rst#downloading-tools>`_
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>`_.
* `Downloading Source Code <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/quick-start/build-open-harmony.rst#downloading-source-code>`_
Get Source Code and Tools
*********************************
To download the source code and tools required for the project, click the following links:
Contribution Guidelines
***************************
We welcome you to join the project OpenHarmony and support us in building an Open Source Community and encourages everyone in the community to submit the patches directly to the project. Based on your interest and expertise, you can contribute to the code or/and documentation.
* Downloading Tools
* Downloading Source Code
* To know the contribution workflow on how to download code and contribute your code back to the repository, please refere `Contribution Process <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/readme/Contribution%20Process.rst>`_.
* To contribute to documentation, please refere `Contributing to the Documentation <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contributing%20to%20the%20Documentation.rst>`_.
* All our documents are written in reStructuredText for easy of writing and processing to different format. You can use ReadTheDoc to publish our documents into anyformat you want, or locally generate the required format output using the Sphinx document generator. For more details, please refere `Documentation using Sphinx <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/readme/reStructuredText%20Basics.rst>`_
* In order to maintain consistency across code base, please refere to the `coding style guide <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Contributing%20to%20the%20Code.rst>`_ before you stat contributing to the code base of OpenHarmony.
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>`_.
Code of Conduct
***************
OpenHarmony is committed to providing a welcoming and inspiring community for all. In order to maintain a collaborative environment, we recommend you to read and follow the community `Code of Conduct <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Code%20of%20Conduct.rst>`_.
********************
OpenHarmony is committed to provide a welcoming and inspiring community for all. In order to maintain a collaborative environment, we recommend you to read and follow the community `Code of Conduct <https://git.ostc-eu.org/docs/developer-guide/-/blob/master/documentation/source/readme/Code%20of%20Conduct.rst>`_.
Contributors & Acknowledgements
*******************************
***************************************
A great Open source project wouldn't exist without the hard work of its many contributors. We'd like to invite anyone from around the world to participate in this exciting journey. And we're grateful for your time, passion, and efforts!
Release
*******
***********
In order to provide new features and bug fixes, the community constantly updates the code and provides new releases.
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