Skip to content

QUICKSTART.md

Latest commit

 

History

History
127 lines (103 loc) · 6.46 KB

QUICKSTART.md

File metadata and controls

127 lines (103 loc) · 6.46 KB

快速开始指南 / Quick Start Guide

5分钟快速上手 / 5-Minute Quick Start

1. 下载和安装 / Download and Install

# 克隆仓库 / Clone repository
git clone https://github.com/yourusername/iar-firmware-publish-tool.git
cd iar-firmware-publish-tool

# 安装依赖 / Install dependencies
pip install -r requirements.txt

2. 首次运行 / First Run

python main.py

3. 基本配置 / Basic Configuration

  1. 点击"设置"按钮 / Click "Settings" button
  2. 配置IAR安装路径（如：C:/Program Files (x86)/IAR Systems/Embedded Workbench 8.3）
    Configure IAR installation path (e.g.: C:/Program Files (x86)/IAR Systems/Embedded Workbench 8.3)
  3. 设置项目路径（包含.ewp文件的目录）
    Set project path (directory containing .ewp files)
  4. 选择编译配置（如果项目有多个配置）
    Select build configuration (if project has multiple configurations)
  5. 选择配置文件（如：main.c）
    Select configuration file (e.g.: main.c)
  6. 可选：配置远程发布 / Optional: Configure Remote Publishing：
    • 设置远程发布目录（绝对路径）/ Set remote publish directory (absolute path)
    • 启用远程发布开关 / Enable remote publish switch
  7. 可选：配置文件发布选项 / Optional: Configure File Publishing Options：
    • 选择是否在文件名中添加时间戳 / Choose whether to add timestamp to filename
    • 选择是否同时发布.out文件 / Choose whether to publish .out files alongside .bin files
  8. 点击"保存" / Click "Save"

4. 开始使用 / Start Using

  1. 点击"开始编译" / Click "Start Compilation"
  2. 工具会自动 / The tool will automatically：
    • 检查Git状态 / Check Git status
    • 递增版本号 / Increment version number
    • 弹出Git提交对话框 / Pop up Git commit dialog：
      • 输入本次更新的详细信息 / Input detailed update information
      • 支持多行输入，按Enter换行，Ctrl+Enter确认 / Support multi-line input, Enter for new line, Ctrl+Enter to confirm
    • 提交版本更改 / Commit version changes
    • 编译项目 / Compile project
    • 修改二进制文件 / Modify binary files
    • 生成Release Notes / Generate Release Notes
    • 发布固件到本地目录（.bin文件，可选.out文件）/ Publish firmware to local directory (.bin file, optional .out file)
    • 如果启用远程发布，复制到远程目录 / If remote publishing is enabled, copy to remote directory

5. 查看结果 / View Results

编译完成后，工具会自动：

  • 修改二进制文件，注入版本和Git信息
  • 生成Release Notes文档
  • 发布固件到指定目录（.bin文件，可选.out文件）
  • 根据设置决定是否在文件名中添加时间戳

常见问题 / FAQ

Q: 提示"配置不完整"怎么办？

Q: What to do when "Configuration incomplete" is prompted? A: 请确保在设置中配置了所有必要参数：
A: Please ensure all necessary parameters are configured in settings:

  • IAR安装路径 / IAR installation path
  • 项目路径 / Project path
  • 配置文件 / Configuration file

注意 / Note：bin起始地址现在会自动从ICF文件中获取，无需手动配置。
Note: bin start address is now automatically retrieved from ICF files, no manual configuration needed.

Q: 编译失败怎么办？

Q: What to do when compilation fails? A: 检查：
A: Check:

  • IAR路径是否正确 / Whether IAR path is correct
  • 项目路径是否包含.ewp文件 / Whether project path contains .ewp files
  • IAR是否已正确安装 / Whether IAR is properly installed

Q: 如何切换语言？

Q: How to switch language? A: 在设置中选择语言选项，支持中文、繁体中文、英文。
A: Select language option in settings, supports Chinese, Traditional Chinese, and English.

Q: 如何打包为exe文件？

Q: How to package as exe file? A: 运行 python build_exe.py，工具会自动递增版本号并生成exe文件到release目录。
A: Run python build_exe.py, the tool will automatically increment version number and generate exe file to release directory.

Q: 远程发布功能如何使用？

Q: How to use remote publishing feature? A: 在设置中配置远程发布目录（绝对路径），启用远程发布开关，工具会自动将固件复制到远程目录的项目名_分支名子目录中。
A: Configure remote publish directory (absolute path) in settings, enable remote publish switch, the tool will automatically copy firmware to project_name_branch_name subdirectory in remote directory.

Q: 如何控制文件名时间戳？

Q: How to control filename timestamp? A: 在设置页面中，有一个"添加时间戳到文件名"的复选框，勾选后文件名会包含时间戳（格式：项目名_v版本号_commitID_YYYYMMDD_HHMMSS.bin），默认不添加。
A: In settings page, there's a "Add timestamp to filename" checkbox. When checked, filename will include timestamp (format: project_name_vversion_commitID_YYYYMMDD_HHMMSS.bin), default is not added.

Q: 如何发布.out文件？

Q: How to publish .out files? A: 在设置页面中，有一个"发布.out文件"的复选框，勾选后工具会同时发布.bin和.out文件到本地和远程目录，文件名保持一致。
A: In settings page, there's a "Publish .out file" checkbox. When checked, the tool will publish both .bin and .out files to local and remote directories with consistent naming.

Q: bin起始地址是如何获取的？

Q: How is bin start address obtained? A: 工具会自动从IAR项目的ICF文件中解析Flash起始地址，无需手动配置。如果解析失败，会使用默认值0x08000000。
A: The tool automatically parses Flash start address from IAR project's ICF files, no manual configuration needed. If parsing fails, it uses default value 0x08000000.

更多帮助 / More Help