说明:你需要在这里对项目进行简单的介绍,描述项目背景,当前现状、功能特点等等……
这是一个在 RT-Thread 上,用于演示的 package 。展示了一个 package 大致包括的内容,以及对应的一些模版文件。
说明:参考下面表格,整理出 packages 的目录结构
名称 | 说明 |
---|---|
docs | 文档目录 |
examples | 例子目录,并有相应的一些说明 |
inc | 头文件目录 |
src | 源代码目录 |
port | 移植代码目录。如果没有移植代码,可以不需要 |
说明:请在这里说明该 package 的授权许可,例如: GPLv2、LGPLv2.1、MIT、Apache license v2.0、BSD 等。
hello package 遵循 LGPLv2.1 许可,详见 LICENSE
文件。
说明:列出该 package 对于其他 package 、RT-Thread 操作系统版本等软件方面的依赖关系。
- RT-Thread 3.0+
说明:描述该 package 位于 menuconfig 的位置,并对与其相关的配置进行介绍
使用 hello package 需要在 RT-Thread 的包管理器中选择它,具体路径如下:
RT-Thread online packages
miscellaneous packages --->
[*] A hello package
然后让 RT-Thread 的包管理器自动更新,或者使用 pkgs --update
命令更新包到 BSP 中。
说明:在这里介绍 package 的移植步骤、使用方法、初始化流程、准备工作、API 等等,如果移植或 API 文档内容较多,可以将其独立至
docs
目录下。
在打开 hello package 后,当进行 bsp 编译时,它会被加入到 bsp 工程中进行编译。
说明:列出在使用这个 package 过程中需要注意的事项;列出常见的问题,以及解决办法。