完善文档

This commit is contained in:
NeoZng
2023-09-27 22:52:26 +08:00
parent 145e886618
commit 50479fc16c
3 changed files with 44 additions and 11 deletions

View File

@@ -110,6 +110,23 @@
} CANInstance;
```
## 其他IDE支持
你还可以尝试VSC的EIDE插件+ozone的方式开发ac5/6工具链的程序。ac5/6工具链由于为arm出品的商业闭源软件对mcu硬件架构的针对性优化更多编译出来的程序优化效果往往更好、体积更小执行速度快过arm-gnu工具链。
另外的可能是Visual Studio + VisualGDB根据VisualGDB的官网进行配置即可可以利用VS提供的各种测试调试性能分析功能。对于熟悉VS丰富的功能支持的开发者可以选择此方式。
还可以尝试VSC的插件KEIL assistant通过此法你需要在根目录打开cubeide配置文件在project manager标签页选择将工具链改为MDK**我们非常不推荐这种方式**。若要使用CubeIDE也在相同的地方修改工具链。
***不过开发本框架的最佳实践仍然是VSCode+Ozone。***
> 只要你学习了[VSCode+Ozone使用方法](./VSCode+Ozone使用方法.md)文档内的*预备知识* 掌握了工具链的用途和原理之后不论换用什么IDE什么编译器你都可以切换自如。
## BSP层(Board Sopport Package)
- 主要功能实现对STM HAL的封装功能进一步抽象硬件。
@@ -190,6 +207,8 @@ ROOT:.
│ debug_ozone.jdebug # ozone debug调试配置和缓存文件
│ LICENSE # 开源协议文件
│ Makefile # 编译管理文件,为make(mingw32-make)命令的目标
| Makefile.upgrade # 编译管理文件的升级版, 资深用户使用
| CMakeLists.txt # cmake构建规则, 资深用户使用
│ openocd_dap.cfg # 用于OpenOCD调试使用的配置文件,dap用
│ openocd_jlink.cfg # 用于OpenOCD调试使用的配置文件,jlink用
│ README.md # 本说明文档
@@ -199,10 +218,6 @@ ROOT:.
│ STM32F407IGHx_FLASH.ld # F407IGH(C板MCU)目标FLASH地址和链接规则,用于编译(作为链接阶段的链接器)
│ task.ps1 # powershell脚本,一键编译并进入ozone调试/reset开发板用
│ TODO.md # 项目待完成的任务
│ VSCode+Ozone使用方法.md # 开发环境配置和前置知识介绍
│ 修改HAL配置时文件目录的更改.md # 重新配置CubeMX时的步骤和注意事项
│ 必须做&禁止做.md # 开发必看,规范和要求
│ 如何定位bug.md # 开发必看,快速定位bug并进行修复.还提供了一些debug典例
├─.vscode
│ launch.json # 调试的配置文件
@@ -210,14 +225,17 @@ ROOT:.
│ tasks.json # 任务配置文件,包括一键编译下载调试等
├─.assets # 说明文档的图片
├─.Doc # 本框架的各类说明文档
├─.github # github action CI支持文件
├─application # 应用层
├─bsp # 板级支持包
├─modules # 模块层
├─Src #hal生成的外设初始化源文件
├─Inc #hal生成的外设初始化头文件
├─Drivers #hal driver和cmsis drivers
└─Middlewares # STusb ext , rtos , segger rtt等
├─Src # hal生成的外设初始化源文件
├─Inc # hal生成的外设初始化头文件
├─Drivers # hal driver和cmsis drivers
└─Middlewares # STusb ext, rtos, segger rtt等
```
## BSP/Module/Application介绍