|
|
@@ -4,7 +4,7 @@
|
|
|
|
|
|
> 说明:你需要在这里对项目进行简单的介绍,描述项目背景,当前现状、功能特点等等……
|
|
|
|
|
|
-这是一个在 RT-Thread 上,用于演示的 package 。展示了一个 package 大致包括哪些东西,以及对应的一些模版文件。
|
|
|
+这是一个在 RT-Thread 上,用于演示的 package 。展示了一个 package 大致包括的内容,以及对应的一些模版文件。
|
|
|
|
|
|
### 1.1 目录结构
|
|
|
|
|
|
@@ -12,10 +12,11 @@
|
|
|
|
|
|
| 名称 | 说明 |
|
|
|
| ---- | ---- |
|
|
|
-| doc | 文档目录 |
|
|
|
-| example | 例子目录,并有相应的一些说明 |
|
|
|
-| inc | 头文件目录 |
|
|
|
-| src | 源代码目录 |
|
|
|
+| docs | 文档目录 |
|
|
|
+| examples | 例子目录,并有相应的一些说明 |
|
|
|
+| inc | 头文件目录 |
|
|
|
+| src | 源代码目录 |
|
|
|
+| port | 移植代码目录。如果没有移植代码,可以不需要 |
|
|
|
|
|
|
### 1.2 许可证
|
|
|
|
|
|
@@ -45,7 +46,7 @@ RT-Thread online packages
|
|
|
|
|
|
## 3、使用 hello
|
|
|
|
|
|
-> 说明:在这里简介使用流程,准备工作、API 等等。如果 package 需要做初始化,额外指出初始化步骤;或者指明对应导出的初始化宏。
|
|
|
+> 说明:在这里介绍 package 的移植步骤、使用方法、初始化流程、准备工作、API 等等,如果移植或 API 文档内容较多,可以将其独立至 `docs` 目录下。
|
|
|
|
|
|
在打开 hello package 后,当进行 bsp 编译时,它会被加入到 bsp 工程中进行编译。
|
|
|
|