Verified Commit 12d98021 authored by Andrei Gherzan's avatar Andrei Gherzan 🐧
Browse files

README.rst: Restructure and rewrite in markdown


Signed-off-by: Andrei Gherzan's avatarAndrei Gherzan <andrei.gherzan@huawei.com>
parent 9726f563
<!--
SPDX-FileCopyrightText: Huawei Inc.
SPDX-License-Identifier: CC-BY-4.0
-->
# OpenHarmony Documentation Repository
[![Documentation Status](https://readthedocs.org/projects/openharmony/badge/?version=latest)](https://openharmony.readthedocs.io/en/latest/?badge=latest)
This repository provides the overarching documentation of the OpenHarmony
project. It does that by aggregating multiple `sphinx` projects part of
OpenHarmony ecosystem and consolidating all these documentation trees as part of
one, project-wide, `sphinx` project.
## Building the docs
As per the current implementation for satisfying aggregation of multiple
`sphinx` projects, the repository takes advantage of symlinks which assume a
workspace set up from [the manifest repository](https://git.ostc-eu.org/OSTC/OHOS/manifest/).
Once that is initialized and synced, one can build/validate the documentation
by simply running:
```
make
```
## Contributing
See the `CONTRIBUTING.md` file.
## License
The license of this repository is as follows:
* Documentation text is under `CC-BY-4.0` license
* Scripts, tools, and so on, are under `Apache-2.0` license
See the `LICENSES` subdirectory for full license texts.
.. SPDX-FileCopyrightText: Huawei Inc.
..
.. SPDX-License-Identifier: CC-BY-4.0
.. include:: definitions.rst
Welcome to OpenHarmony
##############################
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.
Why OpenHarmony?
************************
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
*********************************
* `Getting Started <https://openharmony.readthedocs.io/en/latest/quick-start/build-open-harmony.html>`_
* `Supported Boards <https://openharmony.readthedocs.io/en/latest/supported-boards/README.html>`_
For the latest OpenHarmony Documentation, `Click <https://openharmony.readthedocs.io>`_.
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 contribution process.
* `Downloading Tools <https://openharmony.readthedocs.io/en/latest/quick-start/downloading-tools-and-sourcecode.html#downloading-tools>`_
* `Downloading Source Code <https://openharmony.readthedocs.io/en/latest/quick-start/downloading-tools-and-sourcecode.html#downloading-source-code>`_
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.
* To know the contribution workflow on how to download code and contribute your code back to the repository, refer `Contribution Process <https://openharmony.readthedocs.io/en/latest/readme/Contribution%20Process.html>`_.
* To contribute to documentation, refer `Contributing to the Documentation <https://openharmony.readthedocs.io/en/latest/readme/Contributing%20to%20the%20Documentation.html>`_.
* 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, refer `Documentation using Sphinx <https://openharmony.readthedocs.io/en/latest/readme/reStructuredText%20Basics.html>`_
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://openharmony.readthedocs.io/en/latest/readme/Communication%20in%20Community.html>`_.
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://openharmony.readthedocs.io/en/latest/readme/Code%20of%20Conduct.html>`_.
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. The documentation you are reading matches the |main_project_version| release of OpenHarmony.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment