本章节介绍如何编译 Rabbit。

获取代码

Rabbit 的代码托管在 GitHub 上。你可以通过以下命令克隆代码库:

git clone https://github.com/0xtaruhi/Rabbit.git
cd Rabbit

Rabbit 还需要libusb作为依赖库。你可以直接通过运行以下命令来获取libusb的代码:

git submodule update --init --recursive

安装依赖

Qt6 安装指南

Rabbit 使用 Qt6 作为 GUI 框架。请根据你的操作系统选择合适的安装方式。

推荐使用包管理器安装 Qt6:

# Fedora
sudo dnf install qt6-qtbase-devel qt6-qttools-devel

# Ubuntu/Debian
sudo apt install qt6-base-dev qt6-tools-dev

也可以前往 Qt 官网 下载官方安装器进行安装。

安装完成后,请确保 Qt6 的 bin 目录已加入环境变量 PATH,以便命令行和构建工具可以找到 Qt 工具链。

验证安装:

qmake --version
qtpaths6 --version

如果显示 Qt6 相关信息,则安装成功。

建议使用 Qt 官方安装器 安装 Qt6,或通过 MSYS2 安装:

pacman -S mingw-w64-x86_64-qt6-base mingw-w64-x86_64-qt6-tools

安装完成后,请将 Qt6 的 bin 目录加入环境变量 PATH

验证安装:

qmake --version
qtpaths6 --version

如果显示 Qt6 相关信息,则安装成功。

推荐使用 Homebrew 安装:

brew install qt@6

安装完成后,请将 Qt6 的 bin 目录加入环境变量 PATH

验证安装:

qmake --version
qtpaths6 --version

如果显示 Qt6 相关信息,则安装成功。

更多详细信息请参考 Qt 官方文档

Xmake 安装指南

Xmake 是 Rabbit 使用的跨平台构建工具。可通过以下方式安装:

推荐使用官方脚本一键安装:

curl -fsSL https://xmake.io/shget.text | bash

或使用包管理器:

# Fedora
sudo dnf install xmake

# Ubuntu/Debian
sudo apt install xmake

安装完成后,建议运行以下命令验证安装:

xmake --version

如显示版本号,则安装成功。

可以使用 Scoop 或 Chocolatey 安装:

# Scoop
scoop install xmake

# Chocolatey
choco install xmake

也可以从 xmake 官网 下载并安装。 安装完成后,建议运行以下命令验证安装:

xmake --version

如显示版本号,则安装成功。

推荐使用 Homebrew 安装:

brew install xmake

或使用官方脚本一键安装:

curl -fsSL https://xmake.io/shget.text | bash

安装完成后,建议运行以下命令验证安装:

xmake --version

如显示版本号,则安装成功。

更多详细信息请参考 Xmake 官方文档

编译

编译 libusb

cd libusb
./autogen.sh
./configure
make

使用 Visual Studio 打开libusb/msvc/libusb.sln,并构建静态库(Static Library)。之后将生成的libusb/msvc/libusb/Release/libusb-1.0.lib复制到libusb/libusb/.libs/usb-1.0.lib。注意需要重命名。

使用 xmake 编译 Rabbit

Rabbit 使用 Xmake 进行跨平台编译。

在项目根目录下执行:

xmake

构建完成后,生成的可执行文件一般位于 build/linux/x86_64/release/ 目录下。

如需清理构建文件:

xmake clean

在项目根目录下执行:

xmake

构建完成后,生成的可执行文件一般位于 build/windows/x86_64/release/ 目录下。

如需清理构建文件:

xmake clean

在项目根目录下执行:

xmake

构建完成后,生成的可执行文件一般位于 build/macosx/x86_64/release/ 目录下。

如需清理构建文件:

xmake clean

Note

有时候Xmake可能无法自动检测到Qt的安装路径,可以手动指定Qt路径: bash xmake f --qt=/path/to/qt/bin xmake build 请将/path/to/qt/bin替换为实际的Qt6的bin目录路径。

运行

Rabbit 编译完成后,可直接运行生成的可执行文件。

xmake run

在Linux平台上,有时会出现连接不上开发板的问题,可能是因为权限不足。可以尝试使用sudo运行:

sudo xmake run --root