Skip to content

WINDOWS.md

Latest commit

 

History

History
73 lines (47 loc) · 2.82 KB

WINDOWS.md

File metadata and controls

73 lines (47 loc) · 2.82 KB
Raw

Windows Direct-Run Guide

中文快速说明

普通用户只需要下面任意一个发布文件，不需要 Python、PyQt5、虚拟环境或管理员权限：

ROS-Navigation-Learning-Platform-v1.0.0-win-x86_64.exe
ROS-Navigation-Learning-Platform-v1.0.0-win-x86_64.zip

项目开发者在 Windows 项目根目录运行：

build_windows.bat

脚本会自动使用当前已有的 64 位 Python 3.10-3.14，创建隔离构建环境、安装依赖、生成 EXE/ZIP、执行启动检查并生成 SHA256。这里不再强制要求 py -3.12。成功后，文件位于 dist 目录。

单文件 EXE 可以直接发给 Windows 10/11 Intel/AMD 64 位用户双击运行。首版未签名，SmartScreen 可能显示“未知发布者”；校验 SHA256 后可以点击“更多信息 → 仍要运行”。

For End Users

End users do not need Python, PyQt5, a virtual environment, or administrator privileges. Distribute either of these release files:

ROS-Navigation-Learning-Platform-v1.0.0-win-x86_64.exe
ROS-Navigation-Learning-Platform-v1.0.0-win-x86_64.zip

The single-file EXE can be opened directly. The ZIP package must be extracted first, then run ROS-Navigation-Learning-Platform.exe inside the extracted directory.

The first release is unsigned. Windows SmartScreen may show Windows protected your PC or Unknown publisher. Verify the published SHA256 checksum, select More info, and then select Run anyway.

Build on a Windows PC

The root-level build_windows.bat automatically:

  1. Detects the existing python or py command.
  2. Accepts 64-bit Python 3.10 through 3.14; it does not require exactly Python 3.12.
  3. Creates an isolated .build-venv environment.
  4. Installs PyQt5, PyInstaller, and the required build tools.
  5. Produces the single-file EXE and ZIP package in dist.

Run it from Command Prompt:

build_windows.bat

This build step needs Python because it creates the executable. The resulting EXE does not need Python on other computers.

Build without Installing Python Locally

The repository includes .github/workflows/windows-portable.yml.

  1. Push the project to GitHub.
  2. Open the repository's Actions page.
  3. Select Build Windows Portable.
  4. Select Run workflow.
  5. Download the windows-x86_64-portable artifact when the job completes.

The artifact contains the EXE, ZIP package, and SHA256SUMS-windows.txt.

Why py -3.12 Failed

The command below requests one exact interpreter version:

py -3.12 -m venv .venv

If Python 3.12 is not installed, the Python Launcher reports No suitable Python runtime found, no .venv directory is created, and activation fails. This does not mean the project cannot run with the installed Python. Use python -m venv .venv for source development, or use the portable EXE for normal distribution.