readme.md 5.3 KB
Newer Older
D
duangavin123 已提交
1
# Overview
D
duangavin123 已提交
2

M
mamingshuai 已提交
3 4
This project stores OpenHarmony documentation, including the quick start guide, development guides, and API reference. We appreciate your contribution to the OpenHarmony documentation.

D
duangavin123 已提交
5 6 7
## Contents

- [OpenHarmony Overview](OpenHarmony-Overview.md)
D
duangavin123 已提交
8 9 10 11 12 13
- 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 guide](device-dev/quick-start/Readme-EN.md)  \(covering environment setup, source code acquisition, build, and burning\)
        - Basic development capabilities
W
wusongqing 已提交
14 15
          - **Kernel**:  [Kernel for Mini Systems](device-dev/kernel/kernel-mini.md)
          - **Kernel:**[Kernel for Small Systems](device-dev/kernel/kernel-small.md)
D
duangavin123 已提交
16 17 18 19
          - **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**:  
W
wusongqing 已提交
20
          - [WLAN-connected products](device-dev/guide/device-wlan.md)  \(LED peripheral control and third-party SDK integration\)
D
duangavin123 已提交
21 22 23 24 25 26 27 28 29 30 31 32
          - [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
D
duangavin123 已提交
33
        - **overview**:  [device development overview](device-dev/Readme-EN.md)
D
duangavin123 已提交
34 35
        - **quick-start**:  [quick start guide](device-dev/quick-start/quickstart-standard.md)  \(covering environment setup, source code acquisition, build, and burning\)
        - Basic development capabilities
D
duangavin123 已提交
36 37 38 39
          - **Kernel**:  [Kernel for Standard Systems](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)
D
duangavin123 已提交
40
        - **guide**:
D
duangavin123 已提交
41 42 43
          - [Clock apps](device-dev/guide/device-clock-guide.md)
          - [Platform drivers](device-dev/guide/device-driver-demo.md)
          - [Peripheral drivers](device-dev/guide/device-outerdriver-demo.md)
D
duangavin123 已提交
44
        - **porting**:  
D
duangavin123 已提交
45
          - [Standard  System SoC Porting Guide](device-dev/porting/standard-system-porting-guide.md)
Y
yaoyueyu 已提交
46
          - [A Method for Rapidly Porting the OpenHarmony Linux Kernel ](device-dev/porting/porting-linux-kernel.md)
D
duangavin123 已提交
47
        - **bundles**: 
D
duangavin123 已提交
48 49 50
          - [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)
A
Austin 已提交
51
    - [FAQs](device-dev/faqs/Readme-EN.md)
D
duangavin123 已提交
52 53 54


-   App development
W
wusongqing 已提交
55 56
    -   **Overview**:  [Application Development Overview](application-dev/application-dev-guide.md)
    -   **quick-start**:  [Quick Start Basics](application-dev/quick-start/Readme-EN.md)
D
duangavin123 已提交
57
    -   **ui**:  [UI](application-dev/ui/Readme-EN.md)
W
wusongqing 已提交
58 59
    -   **media**:  [Media](application-dev/media/Readme-EN.md)
    -   **security**: [Security](application-dev/security/Readme-EN.md)
D
duangavin123 已提交
60
    -   **connectivity**:  [networks and connectivity](application-dev/connectivity/Readme-EN.md)
W
wusongqing 已提交
61 62 63
    -   **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)
W
wusongqing 已提交
64
    -   **reference**:  [Development References](application-dev/reference/Readme-EN.md)
D
duangavin123 已提交
65 66 67 68
-   **glossary**:  [glossary](device-dev/glossary/glossary.md)

## Version Change History

N
NEEN 已提交
69
For details, see  [Release Notes](release-notes/Readme.md).
D
duangavin123 已提交
70 71 72

## Third-Party Open-Source Software and License Notice

W
wusongqing 已提交
73 74
3rd-Party-License: [Third-Party Open-Source Software and License Notice](contribute/third-party-open-source-software-and-license-notice.md)

D
duangavin123 已提交
75 76 77 78 79 80 81 82 83

## 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.