diff --git a/bsp/st/README.md b/bsp/st/README.md index 96e284b..3e7508d 100644 --- a/bsp/st/README.md +++ b/bsp/st/README.md @@ -13,4 +13,12 @@ 注:禁止使能中断,否则会报重复定义错误(`MR`框架已接管中断)。 -## 参考仓库目录下的`README`,添加 mr-library +## 将项目导入工程(2.添加驱动) + +复制`bsp/st/driver`和`stm32xxx/driver`文件至`driver`。 + +## 移植驱动 + +参考上一步中`stm32xxx/driver`路径下`Kconfig`和`mr_board.h`,修改参数,完成移植与裁剪。 + +## 继续按仓库目录下`README`,添加 mr-library diff --git a/bsp/st/README_EN.md b/bsp/st/README_EN.md index cc0c3e5..3094aee 100644 --- a/bsp/st/README_EN.md +++ b/bsp/st/README_EN.md @@ -4,13 +4,24 @@ Note: -- This BSP only supports the HAL library, and does not currently support standard library or LL library requirements. -- This BSP needs to be used together with CubeMx. +- This `BSP` only supports the `HAL` library, and does not currently support `standard` library or `LL` library requirements. +- This `BSP` needs to be used together with `CubeMx`. ## Create project -Use CubeMx to create a project for the corresponding chip. Enable the required functions (only need to configure pin mapping relationships, no need to set specific parameter values). +Use `CubeMx` to create a project for the corresponding chip. Enable the required functions (only need to configure pin +mapping relationships, no need to set specific parameter values). -Note: Do not enable interrupts, otherwise it will report redefinition errors (the MR framework has taken over interrupts). +Note: Do not enable interrupts, otherwise it will report redefinition errors (the `MR` framework has taken over +interrupts). -## Refer to the README under the repository directory to add mr-library +## Import project into project (2. Add driver) + +Copy `bsp/st/driver` and `stm32xxx/driver` files to `driver`. + +## Port driver + +Refer to the `stm32xxx/driver` path `Kconfig` and `mr_board.h` in the previous step to modify parameters and complete +the migration and tailoring. + +## Continue to add mr-library by pressing `README` in the repository directory diff --git a/bsp/wch/README.md b/bsp/wch/README.md new file mode 100644 index 0000000..23a5de9 --- /dev/null +++ b/bsp/wch/README.md @@ -0,0 +1,13 @@ +# WCH配置教程 + +[English](README_EN.md) + +## 将项目导入工程(2.添加驱动) + +复制`bsp/wch/driver`和`ch32xxx/driver`文件至`driver`。 + +## 移植驱动 + +参考上一步中`ch32xxx/driver`路径下`Kconfig`和`mr_board.h`,修改参数,完成移植与裁剪。 + +## 继续按仓库目录下`README`,添加 mr-library diff --git a/bsp/wch/README_EN.md b/bsp/wch/README_EN.md new file mode 100644 index 0000000..66f6dca --- /dev/null +++ b/bsp/wch/README_EN.md @@ -0,0 +1,14 @@ +# WCH configuration tutorial + +[中文](README.md) + +## Import project into project (2. Add driver) + +Copy `bsp/wch/driver` and `ch32xxx/driver` files to `driver`. + +## Port driver + +Refer to the `ch32xxx/driver` path `Kconfig` and `mr_board.h` in the previous step to modify parameters and complete +the migration and tailoring. + +## Continue to add mr-library by pressing `README` in the repository directory