Update readme.md

readme.md

@@ -2,10 +2,10 @@
 ## FreeRTOS Application Compatibility Layer (ACL) for RT-Thread
 ## 让基于FreeRTOS开发的应用层无感地迁移到RT-Thread操作系统
 
-# 1 概述
+## 1 概述
 这是一个针对RT-Thread国产操作系统的FreeRTOS操作系统兼容层，可以让原有基于FreeRTOS操作系统的项目快速、无感地迁移到RT-Thread操作系统上，实现在RT-Thread操作系统上无感的使用FreeRTOS的API，同时可以使用RT-Thread的丰富组件。项目基于FreeRTOS V10.4.6版本。
 
-# 2 FreeRTOS的API支持情况
+## 2 FreeRTOS的API支持情况
 兼容层对FreeRTOS的支持情况记录在[issue](https://github.com/RT-Thread-packages/FreeRTOS-Wrapper/discussions/31)中记录。一些支持的函数在功能和使用方法上和FreeRTOS略有不同，在迁移过程中需要注意。
 
 ### 2.1线程、消息队列与互斥量
@@ -54,25 +54,30 @@ RT-Thread不为函数提供FromISR版本，函数可以在中断调用并在内
 src += Glob(os.path.join("portable", "MemMang", "heap_3.c"))
 ```
 在`FreeRTOS/portable/rt-thread/FreeRTOSConfig.h`中通过`configTOTAL_HEAP_SIZE`设置内存堆大小。应用调用`pvPortMalloc/vPortFree`会在一块独立于RT-Thread，大小为`configTOTAL_HEAP_SIZE`的内存堆中分配，RT-Thread内部的内存堆仍然存在，兼容层函数内部分配内存都在RT-Thread的内存堆完成。
+
 ### 2.5线程优先级
 RT-Threa线程优先级数值越小时优先级越高，而FreeRTOS线程优先级数值越大优先级越高。在使用兼容层的FreeRTOS API，如`xTaskCreate`，使用FreeRTOS的规则为线程指定优先级即可。若在应用中将RT-Thread和FreeRTOS API混合使用，在指定线程优先级时要特别注意。可以使用以下两个宏对RT-Thread和FreeRTOS线程优先级做转换：
 ```c
 #define FREERTOS_PRIORITY_TO_RTTHREAD(priority)    ( configMAX_PRIORITIES - 1 - ( priority ) )
 #define RTTHREAD_PRIORITY_TO_FREERTOS(priority)    ( RT_THREAD_PRIORITY_MAX - 1 - ( priority ) )
 ```
+
 ### 2.6线程堆栈大小
 FreeRTOS线程堆栈大小的单位为`sizeof(StackType_t)`，RT-Thread线程堆栈大小为`sizeof(rt_uint8_t)`。使用FreeRTOS API创建线程时一定要遵守FreeRTOS的规则，切勿混淆。
+
 ### 2.7vTaskStartScheduler
 由于RT-Thread和FreeRTOS的内核启动流程不同，使用兼容层时，`main`函数是在一个线程中运行，该线程优先级为`CONFIG_RT_MAIN_THREAD_PRIORITY`。（此选项通过SCons配置，数值越小优先级越高。），此时调度器已经开启。一般的FreeRTOS应用采用以下的方式创建线程：
+
 ```c
 xTaskCreate(pxTask1Code, ......);
 xTaskCreate(pxTask2Code, ......);
 ......
 vTaskStartScheduler();
 ```
+
 使用兼容层时，任何使用`xTaskCreate`创建的线程若优先级比`CONFIG_RT_MAIN_THREAD_PRIORITY`更高，会立即开始执行。`vTaskStartScheduler`只是为了提供对应用的兼容，没有任何实际效果。在使用兼容层时，创建线程要特别注意，确保在调用`xTaskCreate`时，该线程所需的所有资源已经完成初始化，可以正常运行。
 
-# 3 使用方法
+## 3 使用方法
 通过Env工具将兼容层加入到工程中：
 ```shell
 RT-Thread online packages
@@ -80,7 +85,9 @@ RT-Thread online packages
         [*] FreeRTOS Wrapper --->
             Version (latest)
 ```
+
 使用`scons --menuconfig`配置RT-Thread内核，以下选项会影响到FreeRTOS兼容层：
+
 ```c
 RT_USING_TIMER_SOFT /* 使用FreeRTOS定时器时必须开启*/
 RT_TIMER_THREAD_PRIO  /* 定时器线程优先级。与FreeRTOS相反，该选项数值越小优先级越高 */
@@ -92,7 +99,9 @@ RT_TICK_PER_SECOND  /* 相当于FreeRTOS configTICK_RATE_HZ */
 RT_THREAD_PRIORITY_MAX /* 相当于FreeRTOS configMAX_PRIORITIES */
 RT_NAME_MAX /* 相当于FreeRTOS configMAX_TASK_NAME_LEN */
 ```
+
 在`FreeRTOS/portable/rt-thread`提供了`FreeRTOSConfig.h`模版。大部分内容不可以修改或依赖RT-Thread内核的配置，可以手动修改的内容如下：
+
 ```c
 /* 可以选择不使用recursive mutex */
 #ifdef RT_USING_MUTEX
@@ -152,7 +161,7 @@ Task 1 receive data 9 from queue
 Task 1 receive data 10 from queue
 ```
 
-# 4 参考资料
+## 4 参考资料
 RT-Thread文档 [https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/README](https://www.rt-thread.org/document/site/#/rt-thread-version/rt-thread-standard/README)
 
 FreeRTOS文档 [https://www.freertos.org/a00106.html](https://www.freertos.org/a00106.html)