1.简化构建流程,增加排障说明。
This commit is contained in:
31
document/tool/tool.md
Normal file
31
document/tool/tool.md
Normal file
@@ -0,0 +1,31 @@
|
||||
# 自动构建工具
|
||||
|
||||
[English](tool_EN)
|
||||
|
||||
<!-- TOC -->
|
||||
* [自动构建工具](#自动构建工具)
|
||||
* [构建流程](#构建流程)
|
||||
* [支持的命令](#支持的命令)
|
||||
<!-- TOC -->
|
||||
|
||||
`MR` 框架提供自动化构建系统,通过脚本驱动的构建工具可以根据不同`IDE`自动、高效地完成引入与配置。大大降低了框架使用的学习成本以及与不同环境的集成难度。
|
||||
|
||||
## 构建流程
|
||||
|
||||
1. 在命令行中运行`python tool.py`,自动完成工具所需环境的安装。
|
||||
2. 运行`python tool.py -m`,在图形化界面中完成`MR` 框架的配置。配置完成后,自动生成`mr_config.h`头文件。
|
||||
3. 运行`python tool.py -b`,自动化构建项目。
|
||||
|
||||
自动构建工具将完成:
|
||||
|
||||
- `MR` 框架文件的自动导入。
|
||||
- `MR` 框架头文件路径的自动添加。
|
||||
- 自动使能IDE编译工具链的`GNU`支持。
|
||||
|
||||
## 支持的命令
|
||||
|
||||
- `-b`:为开发环境构建项目(支持MDK5、Eclipse)
|
||||
- `-m`:启动图形化配置界面
|
||||
- `-lic`:显示框架的许可证信息
|
||||
|
||||
构建脚本大大简化了配置和集成流程,开发者无需了解工程内部,就可以快速启动开发。
|
||||
37
document/tool/tool_EN.md
Normal file
37
document/tool/tool_EN.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# Automated Build Tool
|
||||
|
||||
[中文](tool)
|
||||
|
||||
<!-- TOC -->
|
||||
* [Automated Build Tool](#automated-build-tool)
|
||||
* [Build Process](#build-process)
|
||||
* [Supported Commands](#supported-commands)
|
||||
<!-- TOC -->
|
||||
|
||||
The MR framework provides an automated build system. The script-driven build tool can automatically and efficiently
|
||||
complete the introduction and configuration according to different IDEs, greatly reducing the learning cost of using the
|
||||
framework and the difficulty of integration with different environments.
|
||||
|
||||
## Build Process
|
||||
|
||||
1. Run `python tool.py` in the command line to automatically install the required environment for the tool.
|
||||
|
||||
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 tool.py -b` automated build projects.
|
||||
|
||||
The automated build tool will complete:
|
||||
|
||||
- Automatic import of MR framework files
|
||||
- Automatic addition of MR framework header file paths
|
||||
- Automatically enable GNU support for the IDE compilation toolchain
|
||||
|
||||
## Supported Commands
|
||||
|
||||
- `-b`:Build projects for the development environment (MDK5, Eclipse support)
|
||||
- `-m`: Launches the graphical configuration interface
|
||||
- `lic`: Displays license information
|
||||
|
||||
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.
|
||||
Reference in New Issue
Block a user