Merge pull request #389 from Amazingkenneth/master

整理文档并将 AutoCorrect 引入 GitHub CI

.github/workflows/ci.yml

@@ -0,0 +1,17 @@
+name: Format Docs and Code
+on: [push, pull_request]
+
+jobs:
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          # Make sure the actual branch is checked out when running on pull requests
+          ref: ${{ github.head_ref }}
+
+      - name: Prettify code
+        uses: creyD/[email protected]
+        with:
+          prettier_options: --write **/*.{js,ts,css,html,yml,inc,json,md}

.travis.yml

@@ -3,18 +3,13 @@ language: c
 os: linux
 dist: trusty
 
-
 compiler: arm-none-eabi-gcc
 
-
 before_install:
-  -  sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa -y
-  -  sudo apt-get update -q
-  -  sudo apt-get install gcc-arm-embedded -y
-
+  - sudo add-apt-repository ppa:team-gcc-arm-embedded/ppa -y
+  - sudo apt-get update -q
+  - sudo apt-get install gcc-arm-embedded -y
 
 script:
-  -  cd board/TencentOS_tiny_EVB_MX_Plus/GCC/hello_world
-  -  make
-
-
+  - cd board/TencentOS_tiny_EVB_MX_Plus/GCC/hello_world
+  - make

ChangeLog.md

@@ -1,12 +1,16 @@
 ## [2.5.2] - 2022-06-28
+
 ### Changed
+
 - modify the global lock to protect the at agent.
 
 ## [2.5.1] - 2022-06-02
+
 ### Added
+
 - add dynamic create and destroy api for task, sem, mutex, event, timer and corresponding unit test case.
 - add tos_task_find api.
 
 ### Changed
-- `TOS_CFG_TASK_DYNAMIC_CREATE_EN` change to `TOS_CFG_OBJ_DYNAMIC_CREATE_EN`.
 
+- `TOS_CFG_TASK_DYNAMIC_CREATE_EN` change to `TOS_CFG_OBJ_DYNAMIC_CREATE_EN`.

README.md

@@ -1,5 +1,5 @@
-
 # 开放原子开源基金会首批孵化项目
+
 ![](./doc/image/introduction/TencentOS_tiny_log.png)
 
 [![license](http://img.shields.io/badge/license-BSD-blue.svg)](https://github.com/Tencent/TencentOS-tiny/blob/master/LICENSE)
@@ -9,10 +9,9 @@
 
 # 一、TencentOS Tiny 简介
 
-[TencentOS tiny](https://cloud.tencent.com/product/tos-tiny) 是腾讯面向物联网领域开发的实时操作系统，具有低功耗，低资源占用，模块化，安全可靠等特点，可有效提升物联网终端产品开发效率。TencentOS tiny 提供精简的 RTOS 内核，内核组件可裁剪可配置，可快速移植到多种主流 MCU (如 STM32 全系列)及模组芯片上。而且，基于 RTOS 内核提供了丰富的物联网组件，内部集成主流物联网协议栈（如 CoAP/MQTT/TLS/DTLS/LoRaWAN/NB-IoT 等），可助力物联网终端设备及业务快速接入腾讯云物联网平台。
+[TencentOS tiny](https://cloud.tencent.com/product/tos-tiny) 是腾讯面向物联网领域开发的实时操作系统，具有低功耗，低资源占用，模块化，安全可靠等特点，可有效提升物联网终端产品开发效率。TencentOS tiny 提供精简的 RTOS 内核，内核组件可裁剪可配置，可快速移植到多种主流 MCU (如 STM32 全系列) 及模组芯片上。而且，基于 RTOS 内核提供了丰富的物联网组件，内部集成主流物联网协议栈（如 CoAP/MQTT/TLS/DTLS/LoRaWAN/NB-IoT 等），可助力物联网终端设备及业务快速接入腾讯云物联网平台。
 
-
-## 1、TencentOS tiny整体架构
+## 1、TencentOS tiny 整体架构
 
 ![](./doc/image/introduction/TencentOS_tiny_Architecture.png)
 
@@ -37,79 +36,98 @@ TencentOS tiny 主体架构图，从下到上主要包括：
 ## 2、TencentOS tiny 优势
 
 ### (1).小体积
+
 最小内核：RAM 0.6KB，ROM 1.8KB
 典型 LoraWAN 及传感器应用：RAM 3.3KB，ROM 12KB
+
 ### (2).低功耗
+
 休眠最低功耗低至 2uA
 支持外设功耗管理框架
+
 ### (3).丰富的 IoT 组件
+
 集成主流 IoT 协议栈
-多种通信模组SAL层适配框架；
+多种通信模组 SAL 层适配框架；
 支持 OTA 升级
 提供简单易用端云 API，加速用户业务接入腾讯云
+
 ### (4).可靠的安全框架
+
 多样化的安全分级方案
 均衡安全需求&成本控制
+
 ### (5).良好的可移植性
-内核及IoT组件高度解耦，提供标准适配层
+
+内核及 IoT 组件高度解耦，提供标准适配层
 提供自动化移植工具，提升开发效率
+
 ### (6).便捷的调试手段
+
 提供云化的最后一屏调试功能
 故障现场信息自动上传云平台，方便开发人员调试分析
 
-## 3、TencentOS tiny携手合作伙伴共建IoT生态
+## 3、TencentOS tiny 携手合作伙伴共建 IoT 生态
 
 ![](./doc/image/introduction/Partners.png)
 
 TencentOS tiny 自开源发布以来也在努力发展合作伙伴，期待合作共赢，共同扩展 IoT 应用生态。目前已经与多家 MCU/IP 核厂家达成了合作，包括意法半导体、恩智浦半导体、兆易半导体、ARM、华大半导体、芯来科技等；也与无线 SOC 和模组厂家达成了广泛的合作关系，包括瑞兴恒方、国民技术、Nordic 蓝牙、亮牛半导体、有人物联网等，
 
-除了MCU和模组外，TencentOS tiny 也积极推进终端产品及项目的落地，目前已经形成了AI智慧农业、智能货柜、智慧会议室等方案，并且在腾讯内部与微信支付、腾讯云智慧行业、 AI 平台部、腾讯微瓴、QQ family 达成内部合作，共同扩展行业生态；同时也开始积极发展外部客户，目前与深圳光合显示科技的墨水屏零售标签、鑫悦购充电桩等达成业务合作。TencentOS tiny 将携手合作伙伴为物联网终端厂家提供更优质的 IoT 终端软件解决方案，方便各种物联网设备快速接入腾讯云，共同扩展 IoT 生态，更好地支撑智慧城市、智能水表、智能家居、智能穿戴、车联网等多种行业应用。
+除了 MCU 和模组外，TencentOS tiny 也积极推进终端产品及项目的落地，目前已经形成了 AI 智慧农业、智能货柜、智慧会议室等方案，并且在腾讯内部与微信支付、腾讯云智慧行业、AI 平台部、腾讯微瓴、QQ family 达成内部合作，共同扩展行业生态；同时也开始积极发展外部客户，目前与深圳光合显示科技的墨水屏零售标签、鑫悦购充电桩等达成业务合作。TencentOS tiny 将携手合作伙伴为物联网终端厂家提供更优质的 IoT 终端软件解决方案，方便各种物联网设备快速接入腾讯云，共同扩展 IoT 生态，更好地支撑智慧城市、智能水表、智能家居、智能穿戴、车联网等多种行业应用。
 
-欢迎 IoT 相关项目合作，有合作需求的请邮件联系 TencentOS tiny 官方工作人员，邮箱地址 ： [email protected]
+欢迎 IoT 相关项目合作，有合作需求的请邮件联系 TencentOS tiny 官方工作人员，邮箱地址：[email protected]
 
 # 二、TencentOS tiny 代码目录
+
 - [TencentOS tiny 代码目录说明](./doc/09.Code_Directories.md)
 
 # 三、TencentOS tiny 参考文档
+
 ## 1、移植指南
+
 - [TencentOS tiny 移植指南（KEIL 版本）](./doc/10.Porting_Manual_for_KEIL.md)
 - [TencentOS tiny 移植指南（IAR 版本）](./doc/11.Porting_Manual_for_IAR.md)
 - [TencentOS tiny 移植指南（GCC 版本）](./doc/12.Porting_Manual_for_GCC.md)
-- [TencentOS tiny 移植指南（基于MDK pack)](./tools/mdk_pack/Documentation/README.md)
-- [TencentOS tiny 移植指南（基于STM32 CubeMx)](./tools/STM32CubeMX_pack/Documentation/README.md)
+- [TencentOS tiny 移植指南（基于 MDK pack)](./tools/mdk_pack/Documentation/README.md)
+- [TencentOS tiny 移植指南（基于 STM32 CubeMx)](./tools/STM32CubeMX_pack/Documentation/README.md)
 
 ## 2、TencentOS tiny 开发指南
+
 - [TencentOS tiny 内核开发指南](./doc/04.Development_Manual.md)
 - [TencentOS tiny API 参考](./doc/05.SDK_Manual.md)
 - [TencentOS tiny 对接腾讯云 IoTHub 开发指南](./doc/08.QCloud_IoTHub_Quick_Start.md)
 
 ## 3、TencentOS tiny 腾讯云大学视频教程
+
 - [TencentOS tiny 端侧开发实践课](https://cloud.tencent.com/edu/paths/series/IoT)
 
 # 四、TencentOS tiny 开源协议
-* TencentOS tiny 遵循 [BSD-3 开源许可协议](LICENSE)
 
+- TencentOS tiny 遵循 [BSD-3 开源许可协议](LICENSE)
 
 # 五、TencentOS tiny 支持的物联网平台
+
 TencentOS tiny 能支持物联网终端设备和业务快速接入[腾讯云物联网平台 IoT Explorer](https://cloud.tencent.com/product/iotexplorer)。
 
-TencentOS tiny 结合腾讯云物联网开发平台 IoT Explorer，已经构筑起连接通讯芯片到云开发的能力，加上已经建设完成的国内最大规模 LoRa 网络，腾讯彻底打通从芯片通讯开发、网络支撑服务，物理设备定义管理，数据分析和多场景应用开发等全链条IoT云开发服务能力，重新定义了物联网开发模式，助力亿级设备多方式多模式低门槛接入腾讯云服务。作为物联网基础设施建设服务者，腾讯将持续打造开放的物联网生态体系，促进物联网生态良性发展。
+TencentOS tiny 结合腾讯云物联网开发平台 IoT Explorer，已经构筑起连接通讯芯片到云开发的能力，加上已经建设完成的国内最大规模 LoRa 网络，腾讯彻底打通从芯片通讯开发、网络支撑服务，物理设备定义管理，数据分析和多场景应用开发等全链条 IoT 云开发服务能力，重新定义了物联网开发模式，助力亿级设备多方式多模式低门槛接入腾讯云服务。作为物联网基础设施建设服务者，腾讯将持续打造开放的物联网生态体系，促进物联网生态良性发展。
 
 # 六、TencentOS tiny 快速入门参考
-TencentOS tiny 联合合作伙伴(南京厚德物联网)设计了定制开发板，如下图：
+
+TencentOS tiny 联合合作伙伴 (南京厚德物联网) 设计了定制开发板，如下图：
 ![](./doc/image/introduction/EVB_MX.png)
 
 - [TencentOS tiny 定制开发板介绍页](http://www.holdiot.com/product/showproduct.php?id=8)，开发者可以基于定制开发板进行快速入门学习，点击下载参考文档
 - [TencentOS-tiny 定制开发板入门指南](./doc/15.TencentOS_tiny_EVB_MX_Plus_Quick_Start.md)
 
 # 七、贡献代码
-* 1.  在您自己的 GitHub 账户下 Fork TencentOS tiny 开源项目；
-* 2.  根据您的需求在本地 clone 一份 TencentOS tiny 代码；
-* 3.  您修改或者新增功能后，push 到您 fork 的远程分支；
-* 4.  创建 pull request，向 TencentOS tiny 官方开发分支提交合入请求；
-* 5.  TencentOS tiny 研发团队会定期 review 代码，通过测试后合入。
 
-# 八、加入TencentOS tiny官方QQ技术交流群
+- 1.  在您自己的 GitHub 账户下 Fork TencentOS tiny 开源项目；
+- 2.  根据您的需求在本地 clone 一份 TencentOS tiny 代码；
+- 3.  您修改或者新增功能后，push 到您 fork 的远程分支；
+- 4.  创建 pull request，向 TencentOS tiny 官方开发分支提交合入请求；
+- 5.  TencentOS tiny 研发团队会定期 review 代码，通过测试后合入。
+
+# 八、加入 TencentOS tiny 官方 QQ 技术交流群
 
 扫码加群，请备注 TencentOS tiny 开发者，工作人员会根据备注进行审核：
 
@@ -121,7 +139,6 @@ TencentOS tiny 联合合作伙伴(南京厚德物联网)设计了定制开发板
 [【TencentOS tiny】环境监测实战项目最终完整版](https://www.bilibili.com/video/av73782956?from=search&seid=4421984671929108231)
 感谢阿正的贡献
 
-
 2.基于野火 stm32f103 开发板上移植的 TencentOS tiny 例程、源码剖析、视频讲解。
 感谢 CSDN 博客专家杰杰的贡献
 
@@ -169,29 +186,28 @@ TencentOS tiny 联合合作伙伴(南京厚德物联网)设计了定制开发板
 
 - [【TencentOS tiny 学习】例程（9）——内存堆](https://github.com/jiejieTop/TencentOS-Demo/tree/master/09-mmheap)
 
-
 ## 视频教程：
 
 - [【TencentOS tiny 学习】视频汇总](https://www.bilibili.com/video/av70478596?from=search&seid=10160676184801585522)
 - [【视频】01-初识 TencentOS tiny](https://www.bilibili.com/video/av70478596/?p=1)
 - [【视频】02-TencentOS tiny 基础知识](https://www.bilibili.com/video/av70478596/?p=2)
 - [【视频】03-TencentOS tiny 移植](https://www.bilibili.com/video/av70478596/?p=3)
-- [【视频】04-TencentOS tiny 任务-1](https://www.bilibili.com/video/av70478596/?p=4)
-- [【视频】05-TencentOS tiny 任务-2](https://www.bilibili.com/video/av70478596/?p=5)
-- [【视频】06-TencentOS tiny 队列-1](https://www.bilibili.com/video/av70478596/?p=6)
-- [【视频】07-TencentOS tiny 队列-2](https://www.bilibili.com/video/av70478596/?p=7)
+- [【视频】04-TencentOS tiny 任务 -1](https://www.bilibili.com/video/av70478596/?p=4)
+- [【视频】05-TencentOS tiny 任务 -2](https://www.bilibili.com/video/av70478596/?p=5)
+- [【视频】06-TencentOS tiny 队列 -1](https://www.bilibili.com/video/av70478596/?p=6)
+- [【视频】07-TencentOS tiny 队列 -2](https://www.bilibili.com/video/av70478596/?p=7)
 - [【视频】08-TencentOS tiny 消息队列](https://www.bilibili.com/video/av70478596/?p=8)
-- [【视频】09-TencentOS tiny 信号量-1](https://www.bilibili.com/video/av70478596/?p=9)
-- [【视频】10-TencentOS tiny 信号量-2](https://www.bilibili.com/video/av70478596/?p=10)
-- [【视频】11-TencentOS tiny 互斥锁-1](https://www.bilibili.com/video/av70478596/?p=11)
-- [【视频】12-TencentOS tiny 互斥锁-2](https://www.bilibili.com/video/av70478596/?p=12)
-- [【视频】13-TencentOS tiny 互斥锁-3](https://www.bilibili.com/video/av70478596/?p=13)
-- [【视频】14-TencentOS tiny 事件-1](https://www.bilibili.com/video/av70478596/?p=14)
-- [【视频】15-TencentOS tiny 事件-2](https://www.bilibili.com/video/av70478596/?p=15)
-- [【视频】16-TencentOS tiny 软件定时器-1](https://www.bilibili.com/video/av70478596/?p=16)
-- [【视频】17-TencentOS tiny 软件定时器-2](https://www.bilibili.com/video/av70478596/?p=11)
-- [【视频】18-TencentOS tiny 软件定时器-3](https://www.bilibili.com/video/av70478596/?p=18)
-
-## 相关PPT资料：
-- [【TencentOS tiny 学习】视频 PPT](https://github.com/jiejieTop/TencentOS-Demo/tree/master/PPT)
+- [【视频】09-TencentOS tiny 信号量 -1](https://www.bilibili.com/video/av70478596/?p=9)
+- [【视频】10-TencentOS tiny 信号量 -2](https://www.bilibili.com/video/av70478596/?p=10)
+- [【视频】11-TencentOS tiny 互斥锁 -1](https://www.bilibili.com/video/av70478596/?p=11)
+- [【视频】12-TencentOS tiny 互斥锁 -2](https://www.bilibili.com/video/av70478596/?p=12)
+- [【视频】13-TencentOS tiny 互斥锁 -3](https://www.bilibili.com/video/av70478596/?p=13)
+- [【视频】14-TencentOS tiny 事件 -1](https://www.bilibili.com/video/av70478596/?p=14)
+- [【视频】15-TencentOS tiny 事件 -2](https://www.bilibili.com/video/av70478596/?p=15)
+- [【视频】16-TencentOS tiny 软件定时器 -1](https://www.bilibili.com/video/av70478596/?p=16)
+- [【视频】17-TencentOS tiny 软件定时器 -2](https://www.bilibili.com/video/av70478596/?p=11)
+- [【视频】18-TencentOS tiny 软件定时器 -3](https://www.bilibili.com/video/av70478596/?p=18)
+
+## 相关 PPT 资料：
 
+- [【TencentOS tiny 学习】视频 PPT](https://github.com/jiejieTop/TencentOS-Demo/tree/master/PPT)