• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ***ExampleName*** Development Board
2*Template positioning: When a third-party development board is introduced to OpenHarmony, the board vendor needs to provide an introduction to the board for developers to quickly understand the board.*
3
4## Introduction
5
6*[Writing Instructions]*
7
8*Describe the functions, scenarios, and key features supported by the development board.*
9
10*Provide a picture to show the appearance of the development board.*
11
12*Provide a bottom board picture.*
13
14*Provide a functional block diagram and an introduction.*
15
16*Name the figures after the development board.*
17
18Reference document: [Hi3861 Development Board](../../device-dev/quick-start/quickstart-appendix-hi3861.md)
19
20********
21## Development Board Specifications
22
23*[Writing Instructions] Provide the module and hardware specifications of the development board.*
24
25## (Optional) Constraints
26
27*[Writing Instructions] Describe the restrictions and suggestions on functions, features, and specifications of the development board, if any.*
28
29********
30
31
32## Key Features
33*[Writing Instructions] List supported key features of OpenHarmony.*
34
35## Pin Definition
36*[Writing Instruction] Describe the definitions of I/O pins, and how to configure pins and connect pins to external components.*
37
38## Setting Up the Development Environment
39
40### System Requirements
41
42*[Writing Instruction] Describe the dependency of the development board on the OpenHarmony system, software environment, and hardware environment.*
43
44### Required Tools
45
46*[Writing Instruction] Provide the paths for downloading the tools used to build and debug the development board.*
47
48### Setup Process
49
50*[Writing Instruction] Describe the procedure for setting up the environment step by step.*
51
52## Building and Debugging
53
54### Building
55
56*[Writing Instruction] Describe how to use OpenHarmony and update OpenHarmony binary files and devices on the development board.*
57
58### Burning
59
60*[Writing Instruction] Describe how to burn images step by step.*
61
62### Running
63
64*[Writing Instruction] Describe how to check whether the lighting, running, and output of the development board are proper.*
65
66
67### Debugging
68
69*[Writing Instruction] Describe how to debug common errors on the development board.*
70
71## First Demo
72
73*[Writing Instruction] Provide a quick start example and running effect based on the development board, or provide the link of the demo source code.*
74
75## References
76
77*[Writing Instruction] Provide links to the reference documents, samples, and FAQs.*
78
79## (Optional) Acknowledgments
80
81*[Writing Instruction] Provide acknowledgements to third-party contributors.*
82