update README

第一次运行会自动安装 torch 等依赖项并下载所需模型和文件，如果模型下载失败，需要手动从 [MEGA](https://mega.nz/folder/gmhmACoD#dkVlZ2nphOkU5-2ACb5dKw) 或 [Google Drive](https://drive.google.com/drive/folders/1uElIYRLNakJj-YS0Kd3r3HE-wzeEvrWd?usp=sharing) 下载 data 文件夹(或者报错里提到缺失的文件)，并保存到源码目录下的对应位置。

## 构建 macOS 应用（适用 apple silicon 芯片）

<i>如果构建不成功也可以直接跑源码</i>

![录屏2023-09-11 14 26 49](https://github.com/hyrulelinks/BallonsTranslator/assets/134026642/647c0fa0-ed37-49d6-bbf4-8a8697bc873e)

```

# 第1步：打开终端并确保当前终端窗口的Python大版本号是3.12，可以用下面的命令确认版本号

python3 -V

# 如果没有安装Python 3.12，可以通过Homebrew安装

brew install python@3.12 python-tk@3.12

# 第2步：克隆仓库并进入仓库工作目录

git clone -b dev https://github.com/dmMaze/BallonsTranslator.git

cd BallonsTranslator

# 第3步：创建和启用 Python 3.12 虚拟环境

python3 -m venv venv

source venv/bin/activate

# 第4步：安装依赖

pip3 install -r requirements.txt

# 第5步：源码运行程序，会自动下载 data 文件，每个文件在20-400MB左右，合计大约1.67GB，需要比较稳定的网络，如果下载报错，请重复运行下面的命令直至不再下载报错并启动程序

# 下载完毕后运行下面的命令，如果正常运行且未报错，则继续进入打包应用程序的步骤

python3 launch.py

# 第6步：下载macos_arm64_patchmatch_libs.7z到项目根目录下的'.btrans_cache'隐藏文件夹

# 该步骤是为了防止打包好的应用程序首次启动时重新下载macos_arm64_patchmatch_libs.7z导致启动失败（大概率）

mkdir ./.btrans_cache

curl -L https://github.com/dmMaze/PyPatchMatchInpaint/releases/download/v1.0/macos_arm64_patchmatch_libs.7z -o ./.btrans_cache/macos_arm64_patchmatch_libs.7z

# 第7步：下载微软雅黑字体并放到fonts文件夹下，该步骤为可选项，不影响打包，只影响字体报错信息

# 第8步：构建 macOS 应用程序中途 sudo 命令需要输入开机密码授予权限

# 安装打包工具pyinstaller

pip3 install pyinstaller

# 删除MacOS下特有的.DS_Store文件，这些文件可能导致打包失败（中概率）

sudo find ./ -name '.DS_Store' -delete

# 开始打包.app应用程序

sudo pyinstaller launch.spec

```

> 📌打包好的应用在`./data/BallonsTranslator/dist/BallonsTranslator.app`，将应用拖到 macOS 的应用程序文件夹即完成安装，开箱即用，不需要另外配置 Python 环境。 

[参考](doc/macOS_app_CN.md)  

可能会有各种问题，目前还是推荐跑源码

## 一键翻译

**建议在命令行终端下运行程序**，首次运行请先配置好源语言/目标语言，打开一个带图片的文件夹，点击 Run 等待翻译完成  

Note the first time you launch it will install the required libraries and download models automatically. If the downloads fail, you will need to download the **data** folder (or missing files mentioned in the terminal) from [MEGA](https://mega.nz/folder/gmhmACoD#dkVlZ2nphOkU5-2ACb5dKw) or [Google Drive](https://drive.google.com/drive/folders/1uElIYRLNakJj-YS0Kd3r3HE-wzeEvrWd?usp=sharing) and save it to the corresponding path in source code folder.

## Build macOS application (compatible with both intel and apple silicon chips)

<i>Note macOS can also run the source code if it didn't work.</i>  

![录屏2023-09-11 14 26 49](https://github.com/hyrulelinks/BallonsTranslator/assets/134026642/647c0fa0-ed37-49d6-bbf4-8a8697bc873e)

#### 1. Preparation

-   Download libs and models from [MEGA](https://mega.nz/folder/gmhmACoD#dkVlZ2nphOkU5-2ACb5dKw "MEGA") or [Google Drive](https://drive.google.com/drive/folders/1uElIYRLNakJj-YS0Kd3r3HE-wzeEvrWd?usp=sharing)

<img width="1268" alt="截屏2023-09-08 13 44 55_7g32SMgxIf" src="https://github.com/dmMaze/BallonsTranslator/assets/134026642/40fbb9b8-a788-4a6e-8e69-0248abaee21a">

-  Put all the downloaded resources into a folder called data, the final directory tree structure should look like:

```

data

├── libs

│   └── patchmatch_inpaint.dll

└── models

    ├── aot_inpainter.ckpt

    ├── comictextdetector.pt

    ├── comictextdetector.pt.onnx

    ├── lama_mpe.ckpt

    ├── manga-ocr-base

    │   ├── README.md

    │   ├── config.json

    │   ├── preprocessor_config.json

    │   ├── pytorch_model.bin

    │   ├── special_tokens_map.json

    │   ├── tokenizer_config.json

    │   └── vocab.txt

    ├── mit32px_ocr.ckpt

    ├── mit48pxctc_ocr.ckpt

    └── pkuseg

        ├── postag

        │   ├── features.pkl

        │   └── weights.npz

        ├── postag.zip

        └── spacy_ontonotes

            ├── features.msgpack

            └── weights.npz

7 directories, 23 files

```

-  Install pyenv command line tool for managing Python versions. Recommend installing via Homebrew.

```

# Install via Homebrew

brew install pyenv

# Install via official script

curl https://pyenv.run | bash

# Set shell environment after install

echo 'export PYENV_ROOT="$HOME/.pyenv"' >> ~/.zshrc

echo 'command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH"' >> ~/.zshrc

echo 'eval "$(pyenv init -)"' >> ~/.zshrc

```

#### 2、Build the application

```

# Enter the `data` working directory

cd data

# Clone the `dev` branch of the repo

git clone -b dev https://github.com/dmMaze/BallonsTranslator.git

# Enter the `BallonsTranslator` working directory

cd BallonsTranslator

# Run the build script, will ask for password at pyinstaller step, enter password and press enter

sh scripts/build-macos-app.sh

```

> 📌The packaged app is at ./data/BallonsTranslator/dist/BallonsTranslator.app, drag the app to macOS application folder to install. Ready to use out of box without extra Python config.

</details> 

[Reference](doc/macOS_app.md)  

Some issues may occur, running the source code directly is the recommended way for now.

# Usage