diff --git a/README.md b/README.md index 29dfa9410ce2f4aa9f8b4c45abf75533e5c81057..19029027a7b9613be128cb93b3d20030ab1b1140 100644 --- a/README.md +++ b/README.md @@ -1 +1,41 @@ -https://developer.arm.com/downloads/-/gnu-rm \ No newline at end of file + + +# 项目说明 + +这是一个用于构建和配置项目的工具集,适用于多种编译环境和平台。项目中包含多个模块,用于执行构建、配置、代码提取等任务。 + +## 主要功能 + +- 支持编译和构建模块。 +- 支持依赖管理与环境变量替换。 +- 提供构建配置解析功能。 +- 提供颜色输出、文件拷贝、哈希校验等辅助功能。 +- 支持从压缩包中提取文件。 + +## 文件结构说明 + +- `build.py`: 主构建脚本,提供构建模块、依赖管理、安装等接口。 +- `build_config.py`: 构建配置解析类,用于解析和执行模块的构建配置。 +- `build_utils.py`: 工具类,包含执行命令、文件拷贝、哈希处理、字符串处理等功能。 +- `build_config.json`: 构建配置文件,存储构建相关配置信息。 +- `env_setup.py`: 环境设置工具,提供文件提取与安装提示功能。 +- `cmake/`: CMake 工具配置文件目录,包含多个平台工具链配置模板。 +- `buildtools/`: 存放构建所需的工具包和依赖库。 + +## 使用说明 + +### 构建模块 + +执行构建操作,请使用 `build.py` 脚本并根据需要选择模块和参数。 + +### 环境设置 + +使用 `env_setup.py` 中的函数进行文件提取或环境配置。 + +## 工具依赖 + +- Python 3.x +- CMake +- 编译工具链(如 GCC、MinGW 等) + +如需更多帮助,请查看具体脚本文件的注释与文档。 \ No newline at end of file