Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TransparentLC committed Mar 2, 2023
1 parent 1be13dc commit a11366f
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 17 deletions.
16 changes: 16 additions & 0 deletions README.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,22 @@ Quick Start:

</details>

### Build `Real-ESRGAN GUI.app` for Apple Silicon (`arm64`)

The `arm64` builds have been tested to perform better than `universal2` builds. If you are using Apple Silicon, it is recommended that you can make an `arm64` build by yourself.

```shell
# 1. Clone this repository.
git clone https://github.com/TransparentLC/realesrgan-gui.git
cd realesrgan-gui

# 2. Run the shell script to start building.
# Password is required for "sudo pyinstaller realesrgan-gui-macOS-arm64.spec"
sh Build-macOS-arm64.sh

# 3. The built application is saved in "./realesrgan-gui/dist/Real-ESRGAN GUI.app".
```

> ⚠️ Since I don't have any device running macOS, I may not be able to handle macOS-related issues.
## Features
Expand Down
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,23 @@

</details>

> ⚠️ 由于我没有运行 macOS 的设备,因此可能无法处理和 macOS 相关的使用问题。
### 一键打包 `arm64` 单架构的 `Real-ESRGAN GUI.app`

经实测,`arm64` 单架构比 `universal2` 双架构在 Apple 芯片 Mac 上的性能表现要更加出色,因此建议 Apple 芯片用户自行打包 `arm64` 单架构应用程序。

1. 准备一台 Apple 芯片 Mac,M1、M1 Pro、M1 Max、M2、M2 Pro、M2 Max 均可。
2. 下载仓库。
```shell
git clone https://github.com/TransparentLC/realesrgan-gui.git
cd realesrgan-gui
```
3. 在终端内运行 shell 脚本一键打包,到 `pyinstaller` 打包环节,`sudo` 命令需要输入开机密码。
```shell
sh Build-macOS-arm64.sh
```
4. 大功告成,打包好的应用在 `./realesrgan-gui/dist/Real-ESRGAN GUI.app`

### 一键打包`arm64`单架构的`Real-ESRGAN GUI.app`
经实测,`arm64`单架构比`universal2`双架构在Apple芯片Mac上的性能表现要更加出色,因此建议Apple芯片用户自行打包`arm64`单架构应用程序。
>第一步:准备一台Apple芯片Mac,M1、M1 Pro、M1 Max、M2、M2 Pro、M2 Max均可。
>
>第二步:下载仓库
>```
>git clone https://github.com/TransparentLC/realesrgan-gui.git
>cd realesrgan-gui
>```
>
>第三步:在终端内运行shell脚本一键打包,到`pyinstaller`打包环节,`sudo`命令需要输入开机密码
>```
>sh Build-macOS-arm64.sh
>```
>
>第四步:大功告成,打包好的应用在`./realesrgan-gui/dist/Real-ESRGAN GUI.app`
> ⚠️ 由于我没有运行 macOS 的设备,因此可能无法处理和 macOS 相关的使用问题。
## 功能介绍

Expand Down

0 comments on commit a11366f

Please sign in to comment.