diff --git a/README.md b/README.md index e81726673b1f4a9921b7734f4f3b44a8622a7331..b51390397c35354a6cce2994465425993f64ce83 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,16 @@ This repository stores device and application development documents provided by OpenHarmony_v1.x_release: OpenHarmony v1.1.4 LTS. [Learn more](en/release-notes/OpenHarmony-v1-1-4-LTS.md) [More versions](en/release-notes/) + + +## Third-Party Open-Source Software and License Notice + +3rd-Party-License: [Third-Party Open-Source Software and License Notice](en/contribute/third-party-open-source-software-and-license-notice.md) + +## How to Contribute + +A great open-source project wouldn't be possible without the hard work of many contributors. We'd like to invite anyone from around the world to [participate](contribute/contribution.md) in this exciting journey, and we're grateful for your time, passion, and efforts! + +You can evaluate available documents, make simple modifications, provide feedback on document quality, and contribute your original content. For details, see [Documentation Contribution](contribute/documentation-contribution.md). + +Excellent contributors will be awarded and the contributions will be publicized in the developer community. diff --git a/en/OpenHarmony-Overview.md b/en/OpenHarmony-Overview.md index ef74be27d5cd11a3382871e5b9821a2560c3e163..7619e767e4ff6a5b41c0dc345064c0c2891afe51 100644 --- a/en/OpenHarmony-Overview.md +++ b/en/OpenHarmony-Overview.md @@ -1,4 +1,4 @@ -# OpenHarmony +# OpenHarmony ## Introduction @@ -331,7 +331,8 @@ The following table describes the subsystems of OpenHarmony. For details about t ## Getting Started -For details, see [device-dev/quick-start/Readme-EN.md](device-dev/quick-start/Readme-EN.md). +- Device development: [device-dev/quick-start/Readme.md](device-dev/quick-start/Readme-EN.md) +- Application development: [application-dev/quick-start/Readme.md](application-dev/quick-start/Readme-EN.md) - [Getting Started for Device Development](device-dev/quick-start/quickstart-lite-overview.md) - [Getting Started for Application Development](application-dev/quick-start/start-overview.md) @@ -377,4 +378,3 @@ Website: Email: contact@openharmony.io - diff --git a/en/readme.md b/en/readme.md index 042d89cfe11b269551d81f8239bda479ca4cb26d..7c8b305e741b55835c6bfdc14a794b69de572487 100644 --- a/en/readme.md +++ b/en/readme.md @@ -1,83 +1,12 @@ -# Overview - -This project stores OpenHarmony documentation, including the quick start guide, development guides, and API reference. We appreciate your contribution to the OpenHarmony documentation. - -## Contents - -- [OpenHarmony Overview](OpenHarmony-Overview.md) -- Device development - - Mini and Small System Development Guidelines \(Reference Memory < 128 MB\) - - Device development - - **overview**: [Device Development Overview](device-dev/Readme-EN.md) - - **quick-start**: [Quick Start](device-dev/quick-start/Readme-EN.md) \(covering environment setup, source code acquisition, build, and burning\) - - Basic development capabilities - - **Kernel**: [Kernel for Mini Systems](device-dev/kernel/kernel-mini.md) - - **Kernel：**[Kernel for Small Systems](device-dev/kernel/kernel-small.md) - - **Drivers**: [drivers](device-dev/driver/Readme-EN.md) - - **Subsystems**: [subsystems](device-dev/subsystems/Readme-EN.md) \(such as compilation and building, graphics, DFX, and XTS\) - - **Security**: [privacy and security](device-dev/security/Readme-EN.md) - - **guide**: - - [WLAN-connected Products](device-dev/guide/device-wlan.md) \(LED peripheral control and third-party SDK integration\) - - [Screenless Cameras](device-dev/guide/device-iotcamera-control.md) \(camera control\) - - [Cameras with a Screen](device-dev/guide/device-camera.md) \(screen and camera control, visual application development\) - - **porting**: - - [Third-Party Library Porting Guide for Mini and Small Systems](device-dev/porting/porting-thirdparty.md) - - [Mini System SoC Porting Guide](device-dev/porting/porting-minichip.md) - - [Small System SoC Porting Guide](device-dev/porting/porting-smallchip.md) - - **bundles**: - - [HPM Bundle Development Specifications](device-dev/bundles/bundles-standard-rules.md) - - [HPM Bundle Development Guidelines](device-dev/bundles/bundles-guide.md) - - [HPM User Guide](device-dev/bundles/bundles-demo.md) - - Standard System Development Guidelines \(Reference Memory ≥ 128 MB\) - - Device development - - **overview**: [Device Development Overview](device-dev/Readme-EN.md) - - **quick-start**: [Quick Start](device-dev/quick-start/quickstart-standard.md) \(covering environment setup, source code acquisition, build, and burning\) - - Basic development capabilities - - **Kernel**: [Kernel for the Standard System](device-dev/kernel/kernel-standard.md) - - **Drivers**: [Drivers](device-dev/driver/Readme-EN.md) - - **Subsystems**: [Subsystems](device-dev/subsystems/Readme-EN.md) \(such as compilation and building, graphics, DFX, and XTS\) - - **Security**: [Privacy and Security](device-dev/security/Readme-EN.md) - - **guide**: - - [Development Guidelines on Clock Apps](device-dev/guide/device-clock-guide.md) - - [Development Example for Platform Drivers](device-dev/guide/device-driver-demo.md) - - [Development Example for Peripheral Drivers](device-dev/guide/device-outerdriver-demo.md) - - **porting**: - - [Standard System SoC Porting Guide](device-dev/porting/standard-system-porting-guide.md) - - [A Method for Rapidly Porting the OpenHarmony Linux Kernel ](device-dev/porting/porting-linux-kernel.md) - - **bundles**: - - [HPM Bundle Development Specifications](device-dev/bundles/bundles-standard-rules.md) - - [HPM Bundle Development Guidelines](device-dev/bundles/bundles-guide.md) - - [HPM User Guide](device-dev/bundles/bundles-demo.md) - - [FAQs](device-dev/faqs/Readme-EN.md) - - -- App development - - **Overview**: [Application Development Overview](application-dev/application-dev-guide.md) - - **quick-start**: [Quick Start](application-dev/quick-start/Readme-EN.md) - - **ui**: [UI](application-dev/ui/Readme-EN.md) - - **media**: [Media](application-dev/media/Readme-EN.md) - - **security**: [Security](application-dev/security/Readme-EN.md) - - **connectivity**: [Connectivity](application-dev/connectivity/Readme-EN.md) - - **Database**：[Data Management](application-dev/database/Readme-CN.md) - - **usb**: [USB Service](application-dev//usb/Readme-EN.md) - - **dfx**: [DFX](application-dev/dfx/Readme-EN.md) - - **reference**: [Development References](application-dev/reference/Readme-EN.md) -- **glossary**: [Glossary](device-dev/glossary/glossary.md) - -## Version Change History - -For details, see [OpenHarmony Release Notes](release-notes/Readme.md). - -## Third-Party Open-Source Software and License Notice - -3rd-Party-License: [Third-Party Open-Source Software and License Notice](contribute/third-party-open-source-software-and-license-notice.md) - - -## How to Contribute - -A great open-source project wouldn't be possible without the hard work of many contributors. We'd like to invite anyone from around the world to [participate](contribute/contribution.md) in this exciting journey, and we're grateful for your time, passion, and efforts! - -You can evaluate available documents, make simple modifications, provide feedback on document quality, and contribute your original content. For details, see [Documentation Contribution](contribute/documentation-contribution.md). - -Excellent contributors will be awarded and the contributions will be publicized in the developer community. - +# OpenHarmony Documentation + +This repository stores a complete range of OpenHarmony documentation. The content outline is as follows: + +- OpenHarmony Development + - [Device Development](device-dev/Readme-EN.md) + - [Application Development](application-dev/Readme-EN.md) + - [Release Notes](release-notes/Readme.md) + - [Subsystems](./readme) +- OpenHarmony Contribution + - [How to Contribute](contribute/contribution.md) + - [OpenHarmony Part and API Design Reference](./design)