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

Readthedoc

parent 8ebd8c4a
No related branches found
No related tags found
No related merge requests found
Welcome to Open Harmony Welcome to OpenHarmony
######################## ######################
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. OpenHarmony is an open-source operating system project launched by Huawei with the aim of developing a pool of devices that can communicate and co-operate together irrespective of their make and model.
OpenHarmony is bridging to a new IoT frontier where any devices you can imagine as connected together, you can imagine to do it transcending the traditional relation between devices and operating system. A revolutionary concept coming to life, thanks to a distributed architecture design based on a set of system capabilities. OpenHarmony OS is able to understand which features and capabilities will improve the UX and propose the best solution for a seamless user experience. It will run on a wide range of user devices that accompany your daily life from health, to fitness, to home appliances, and much more.
Motivation Why OpenHarmony?
************* ****************
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. 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 is a device-independent platform. The initial version supports devices with 128 KB to 128 MB of memory and the subsequent versions will support higher memory and advanced devices. 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 OpenHarmony Documentation
*********************************** *************************
* `Getting Started <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/quick-start/build-open-harmony.rst>`_ * `Getting Started <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/quick-start/build-open-harmony.rst>`_
* `Supported Boards <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/MainReadme/documentation/source/supported-boards/Readme.rst>`_ * `Supported Boards <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/supported-boards/README.rst>`_
For the latest OpenHarmony Documentation, `Click <https://openharmony-documentation.readthedocs.io>`_. For the latest OpenHarmony Documentation, `Click <https://openharmony-documentation.readthedocs.io>`_.
Get Source Code and Tools 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. 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.
* `Downloading Tools <https://git.ostc-eu.org/OSTC/OHOS/docs/developer-guide/-/blob/master/documentation/source/quick-start/build-open-harmony.rst#downloading-tools>`_ * `Downloading Tools <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/quick-start/build-open-harmony.rst#id1>`_
* `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>`_ * `Downloading Source Code <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/quick-start/build-open-harmony.rst#id2>`_
Contribution Guidelines 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. 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.
* 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 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/Documentation/-/blob/master/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>`_. * To contribute to documentation, please refere `Contributing to the Documentation <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/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>`_ * 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. * In order to maintain consistency across code base, please refere to the `coding style guide <https://git.ostc-eu.org/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Contributing%20to%20the%20Code.rst>`_ before you stat contributing to the code base of OpenHarmony.
Where to Turn for Help 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>`_. 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/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Communication%20in%20Community.rst>`_.
Code of Conduct Code of Conduct
******************** ***************
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>`_. 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/OSTC/OHOS/docs/Documentation/-/blob/master/readme/Code%20of%20Conduct.rst>`_.
Contributors & Acknowledgements 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! 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 Release
*********** *******
In order to provide new features and bug fixes, the community constantly updates the code and provides new releases. In order to provide new features and bug fixes, the community constantly updates the code and provides new releases.
...@@ -59,4 +59,4 @@ html_theme = 'sphinx_rtd_theme' ...@@ -59,4 +59,4 @@ html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] # html_static_path = ['_static']
...@@ -9,8 +9,8 @@ Welcome to |main_project_name| documentation! ...@@ -9,8 +9,8 @@ Welcome to |main_project_name| documentation!
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
overview/Readme overview/README
quick-start/build-open-harmony quick-start/build-open-harmony
supported-boards/Readme supported-boards/README
readme/Readme readme/README
term/glossary term/glossary
...@@ -7,7 +7,7 @@ version: 2 ...@@ -7,7 +7,7 @@ version: 2
# Build documentation in the docs/ directory with Sphinx # Build documentation in the docs/ directory with Sphinx
sphinx: sphinx:
configuration: docs/conf.py configuration: conf.py
# Build documentation with MkDocs # Build documentation with MkDocs
#mkdocs: #mkdocs:
...@@ -17,4 +17,4 @@ sphinx: ...@@ -17,4 +17,4 @@ sphinx:
python: python:
version: 3.7 version: 3.7
install: install:
- requirements: docs/requirements.txt - requirements: requirements.txt
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