diff --git a/README.md b/README.md index 06e726c..d7d4e09 100644 --- a/README.md +++ b/README.md @@ -123,10 +123,10 @@ int main(void) | driver | 驱动文件 | | include | 库头文件 | | source | 库源文件 | -| build.py | 自动构建脚本 | | Kconfig | 配置文件 | | kconfig.py | 自动配置脚本 | | LICENSE | 许可证 | +| tool.py | 自动构建脚本 | ---------- @@ -171,22 +171,27 @@ int main(void) ![工程目录](document/picture/readme/project.png) -5. 使用自动构建脚本，完成自动构建。在 `mr-library` 路径下，打开命令行工具，运行： - - - `MDK`：`python build.py -mdk` - - `Eclipse`：`python build.py -ecl` +5. 使用自动构建脚本，完成自动构建。在 `mr-library` 路径下，打开命令行工具，运行 `python tool.py -b` 以`MDK`为例： ![MDK自动构建](document/picture/readme/build_mdk.png) + 注： + - 支持`MDK5`、`Eclipse`。 + - `MDK`版本过低可能导致`GNU`配置失败。 + ## 配置菜单选项 -1. 在 `mr-library` 目录下打开命令行工具，运行 `python build.py -m` 进行菜单配置。 +1. 在 `mr-library` 目录下打开命令行工具，运行 `python tool.py -m` 进行菜单配置。 ![配置工具1](document/picture/readme/kconfig_main1.png) -2. 选中 `Device configure` 回车进入菜单，按照需要配置功能。 + 运行失败： + - 检查`Python`版本（暂不支持`3.11.7`以上的版本，重新安装并删除已安装的模块）。 + - 命令行工具不支持，推荐使用`powershell(win10及以上)`、`git bash(较新版本)`等。 + +2. 选中 `Device configure` 回车进入菜单，配置功能。 ![配置工具2](document/picture/readme/kconfig_main2.png) @@ -196,7 +201,7 @@ int main(void) 4. 工程中引入 `#include "include/mr_lib.h"` 并在 `main` 函数中添加 `mr_auto_init();` 自动初始化函数，即可开始使用。 -注：更多命令可输入：`python build.py -h` 查看。 +注：更多命令可输入：`python tool.py -h` 查看。 ---------- diff --git a/README_EN.md b/README_EN.md index 748b5f1..937a3ab 100644 --- a/README_EN.md +++ b/README_EN.md @@ -133,10 +133,10 @@ the `Python` script automatically generates the configuration file. | driver | Driver file | | include | Library header file | | source | Library source file | -| build.py | Automatic build script | | Kconfig | Configuration files | | kconfig.py | Automatic configuration script | | LICENSE | Open-source license | +| tool.py | Automatic build script | ---------- @@ -186,21 +186,26 @@ Versions later than `3.11.7` are not supported). ![project directory](document/picture/readme/project.png) -5. Use the automatic build script to complete the automatic build. In the `mr-library` path, open the command line tool and run: - - - `MDK`：`python build.py -mdk` - - `Eclipse`：`python build.py -ecl` +5. Use the automatic build script to complete the automatic build. In the `mr-library` path, open the command line tool and run `python tool.py -b` Take `MDK` as an example: ![MDK auto build](document/picture/readme/build_mdk.png) + Note: + - Supports `MDK5` and `Eclipse`. + - If the `MDK` version is too early, the `GNU` configuration may fail. + ## Configure Menu Options -1. Open the command line tool in the `mr-library` directory and run `python build.py -m` for menu configuration. +1. Open the command line tool in the `mr-library` directory and run `python tool.py -m` for menu configuration. ![Tool1](document/picture/readme/kconfig_main1.png) + Run failed: + - Check the `Python` version (versions above `3.11.7` are not currently supported, reinstall and remove the installed modules). + - Command line tools are not supported, recommended to use `powershell(win10 and above)`, `git bash(newer version)` and so on. + 2. Enter the menu by pressing the Enter key on `Device configure`, and configure the desired functions according to needs. @@ -214,7 +219,7 @@ Versions later than `3.11.7` are not supported). 4. In the project, introduce `#include include/mr_lib.h`and add`mr_auto_init()`to`main`function; Automatically initialize the function and start using it. -Note: More commands can be entered: `python build.py -h` to view. +Note: More commands can be entered: `python tool.py -h` to view. ---------- diff --git a/document/build/build.md b/document/tool/tool.md similarity index 57% rename from document/build/build.md rename to document/tool/tool.md index 267cd6b..c9a855d 100644 --- a/document/build/build.md +++ b/document/tool/tool.md @@ -1,6 +1,6 @@ # 自动构建工具 -[English](build_EN.md) +[English](tool_EN) * [自动构建工具](#自动构建工具) @@ -12,9 +12,9 @@ ## 构建流程 -1. 在命令行中运行`python build.py`，自动完成工具所需环境的安装。 -2. 运行`python build.py -m`，在图形化界面中完成`MR` 框架的配置。配置完成后，会自动生成`mr_config.h`头文件。 -3. 运行`python build.py -ide`，根据`IDE`类型(`-mdk`或`-ecl`)，完成自动化配置。 +1. 在命令行中运行`python tool.py`，自动完成工具所需环境的安装。 +2. 运行`python tool.py -m`，在图形化界面中完成`MR` 框架的配置。配置完成后，自动生成`mr_config.h`头文件。 +3. 运行`python tool.py -b`，自动化构建项目。 自动构建工具将完成： @@ -24,9 +24,8 @@ ## 支持的命令 -- `m`：启动图形用户界面来配置框架 -- `lic`：显示框架的许可证信息 -- `mdk`：为Keil开发环境构建项目 -- `ecl`：为Eclipse开发环境构建项目设置 +- `-b`：为开发环境构建项目（支持MDK5、Eclipse） +- `-m`：启动图形化配置界面 +- `-lic`：显示框架的许可证信息 构建脚本大大简化了配置和集成流程，开发者无需了解工程内部，就可以快速启动开发。 diff --git a/document/build/build_EN.md b/document/tool/tool_EN.md similarity index 62% rename from document/build/build_EN.md rename to document/tool/tool_EN.md index 835f51c..216a59f 100644 --- a/document/build/build_EN.md +++ b/document/tool/tool_EN.md @@ -1,6 +1,6 @@ # Automated Build Tool -[中文](build.md) +[中文](tool) * [Automated Build Tool](#automated-build-tool) @@ -14,12 +14,12 @@ framework and the difficulty of integration with different environments. ## Build Process -1. Run `python build.py` in the command line to automatically install the required environment for the tool. +1. Run `python tool.py` in the command line to automatically install the required environment for the tool. -2. Run `python build.py -m` to complete the configuration of the MR framework in a graphical interface. After the - configuration is completed, it will automatically generate the `mr_config.h` header file. +2. Run `python tool.py -m` to complete the configuration of the MR framework in a graphical interface. After the + configuration is completed, automatically generate the `mr_config.h` header file. -3. Run `python build.py -ide` according to the IDE type (`-mdk` or `-ecl`) to complete the automatic configuration. +3. Run `python tool.py -b` automated build projects. The automated build tool will complete: @@ -29,10 +29,9 @@ The automated build tool will complete: ## Supported Commands -- `m`: Launches the graphical configuration interface +- `-b`：Build projects for the development environment (MDK5, Eclipse support) +- `-m`: Launches the graphical configuration interface - `lic`: Displays license information -- `mdk`: Configures the project for MDK (Keil) -- `ecl`: Configures the project for Eclipse The build script greatly simplifies the configuration and integration process, allowing developers to quickly start development without needing to understand the internal workings of the project. \ No newline at end of file