diff --git a/docs/developer-manual.md b/docs/developer-manual.md index ba3c76504834b85f9dc886b2e28d4ae4afcc24b3..86c398e43e68ad2007e3e091197ec113ec265473 100644 --- a/docs/developer-manual.md +++ b/docs/developer-manual.md @@ -1,10 +1,10 @@ -# OmniVirt开发者文档 +# EulerLauncher开发者文档 -## 构建OmniVirt +## 构建EulerLauncher -OmniVirt使用Python语言编写,源代码可以跨平台运行,但需要安装Python运行时。为了方便用户使用,可以将源代码编译为二进制形式。在不同的操作系统上构建的步骤略有不同,具体请参照下述指南。 +EulerLauncher使用Python语言编写,源代码可以跨平台运行,但需要安装Python运行时。为了方便用户使用,可以将源代码编译为二进制形式。在不同的操作系统上构建的步骤略有不同,具体请参照下述指南。 -## 在MacOS上构建OmniVirt +## 在MacOS上构建EulerLauncher ### 准备阶段 @@ -16,7 +16,7 @@ OmniVirt使用Python语言编写,源代码可以跨平台运行,但需要安 参考[Homebrew官网][2]完成Homebrew安装 -OmniVirt使用`Pyinstaller`将源码编译为MacOS可执行文件(Unix二进制文件)及`.app`文件,使用`create-dmg`工具将`.app`构建成为`.dmg`磁盘文件以方便软件安装。 +EulerLauncher使用`Pyinstaller`将源码编译为MacOS可执行文件(Unix二进制文件)及`.app`文件,使用`create-dmg`工具将`.app`构建成为`.dmg`磁盘文件以方便软件安装。 使用下面命令安装`Pyinstaller` @@ -33,7 +33,7 @@ brew install create-dmg 进入项目目录并准备开始工作 ``` Shell -cd /path/to/OmniVirt +cd /path/to/EulerLauncher ``` 安装项目依赖 @@ -44,23 +44,23 @@ pip3 install -r requirements.txt ### 构建 -OmniVirt可执行文件包括以下几个部分: +EulerLauncher可执行文件包括以下几个部分: -1. OmniVirtd: omnivirt守护进程,以root权限运行在后台,与调用虚拟化组件(Qemu、HyperV、KVM等)及镜像组件进行相关操作; -2. OmniVirt.app: OmniVirt服务端主程序,将omnivirtd及其他相关程序、数据、文件等打包为MacOS APP软件包,便于分发和使用。 -3. omnivirt: MacOS可执行文件,OmniVirt客户端CLI工具,用于与服务端交互。 +1. EulerLauncherd: omnivirt守护进程,以root权限运行在后台,与调用虚拟化组件(Qemu、HyperV、KVM等)及镜像组件进行相关操作; +2. EulerLauncher.app: OmniVirt服务端主程序,将omnivirtd及其他相关程序、数据、文件等打包为MacOS APP软件包,便于分发和使用。 +3. EulerLauncher: MacOS可执行文件,OmniVirt客户端CLI工具,用于与服务端交互。 4. install: MacOS可执行文件,将OmniVirt运行所需配置文件及相关数据文件安装至`Application Support`文件夹。 -由于`OmniVirt.app`对`OmniVirtd`有依赖关系,请严格按照以下顺序构建`OmniVirtd`及`OmniVirt.app`: +由于`EulerLauncher.app`对`EulerLauncherd`有依赖关系,请严格按照以下顺序构建`EulerLauncherd`及`EulerLauncher.app`: -1. OmniVirtd: +1. EulerLauncherd: 项目源码中已包含用于构建OmniVirtd的Spec脚本`OmniVirtd-Mac.spec`, 若非必要,请勿修改该文件,使用一下命令开始构建: ``` Shell pyinstaller --clean --noconfirm OmniVirtd-Mac.spec ``` -2. OmniVirt.app: +2. EulerLauncher.app: 项目源码中已包含用于构建OmniVirt的Spec脚本`OmniVirt-MacOS.spec`, 若非必要,请勿修改该文件,使用一下命令开始构建: ``` Shell @@ -87,7 +87,7 @@ cp -R dist/OmniVirt.app dist/dmg create-dmg --volname "OmniVirt" --volicon "etc/images/favicon.png" --window-pos 200 120 --window-size 600 300 --icon-size 100 --icon "OmniVirt.app" 175 120 --hide-extension "OmniVirt.app" --app-drop-link 425 120 "dist/OmniVirt.dmg" "dist/dmg/" ``` -`OmniVirt.dmg`中将只包含`OmniVirt.app`主程序,需要将`install`脚本及`omnivirt` CLI工具一并压缩后再进行分发。 +`EulerLauncher.dmg`中将只包含`EulerLauncher.app`主程序,需要将`install`脚本及`EulerLauncher` CLI工具一并压缩后再进行分发。 [1]: https://www.python.org/ [2]: https://brew.sh/ \ No newline at end of file