Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tisfeng committed Dec 12, 2023
1 parent ce999ae commit 6cfee60
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
- [1. 手动下载安装](#1-手动下载安装)
- [2. Homebrew 安装](#2-homebrew-安装)
- [开发者构建](#开发者构建)
- [构建环境](#构建环境)
- [签名问题 ⚠️](#签名问题-️)
- [使用](#使用)
- [鼠标划词](#鼠标划词)
Expand Down Expand Up @@ -119,26 +120,30 @@ brew install easydict

<p>

1. 下载这个 Repo,然后使用 [Xcode](https://developer.apple.com/xcode/) 打开 `Easydict.xcworkspace` 文件(注意不是 `Easydict.xcodeproj`)。
1. 下载这个 Repo,然后使用 [Xcode](https://developer.apple.com/xcode/) 打开 `Easydict.xcworkspace` 文件(注意不是 `Easydict.xcodeproj`⚠️⚠️⚠️)。
2. 使用 `Cmd + R` 编译运行即可。

![image-20231212125308372](https://raw.githubusercontent.com/tisfeng/ImageBed/main/uPic/image-20231212125308372-1702356789.png)

以下是可选步骤,仅面向开发协作者。

对于开发协作者,如果想使用自己的苹果账号运行,请修改 Easydict-debug.xcconfig 文件中的 DEVELOPMENT_TEAM 为你自己的 Apple Team ID(你可以登录苹果开发者网站找到它),CODE_SIGN_IDENTITY 改为 Apple Development。
如果经常需要调试一些权限相关的功能,例如取词或 OCR,可选择使用自己的苹果账号运行,请修改 Easydict-debug.xcconfig 文件中的 DEVELOPMENT_TEAM 为你自己的 Apple Team ID(你可以登录苹果开发者网站找到它),CODE_SIGN_IDENTITY 改为 Apple Development。

注意不要提交 Easydict-debug.xcconfig 文件,你可以使用下面 git 命令忽略这个文件的本地修改
⚠️ 注意不要提交 Easydict-debug.xcconfig 文件,你可以使用下面 git 命令忽略这个文件的本地修改

```bash
git update-index --skip-worktree Easydict-debug.xcconfig
```

构建环境:Xcode 13+, macOS Big Sur 11.3+。为避免不必要的问题,建议使用最新的 Xcode 和 macOS 版本 https://github.com/tisfeng/Easydict/issues/79
#### 构建环境

Xcode 13+, macOS Big Sur 11.3+。为避免不必要的问题,建议使用最新的 Xcode 和 macOS 版本 https://github.com/tisfeng/Easydict/issues/79

>[!NOTE]
> 由于最新代码使用了 String Catalog 功能,因此需要 Xcode 15+ 才能编译。
> 如果你的 Xcode 版本较低,请使用 [xcode-14](https://github.com/tisfeng/Easydict/tree/xcode-14) 分支,注意这是一个固定版本分支,不受维护。
如果运行遇到下面错误,请尝试更新 CocoaPods,然后 `pod install`
如果运行遇到下面错误,请尝试升级 CocoaPods 到最新版本,然后执行 `pod install`

> [DT_TOOLCHAIN_DIR cannot be used to evaluate LD_RUNPATH_SEARCH_PATHS, use TOOLCHAIN_DIR instead](https://github.com/CocoaPods/CocoaPods/issues/12012)
Expand Down
17 changes: 10 additions & 7 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
- [1. Manual Installation](#1-manual-installation)
- [2. Homebrew](#2-homebrew)
- [Developer Build](#developer-build)
- [Build Environment](#build-environment)
- [Signature Problem ⚠️](#signature-problem-️)
- [Usage](#usage)
- [Select text by Mouse](#select-text-by-mouse)
Expand Down Expand Up @@ -114,26 +115,28 @@ brew install easydict

If you are a developer, or you are interested in this project, you can also try to build and run it manually. The whole process is very simple, even without knowing macOS development knowledge.

<details> <summary> Build Steps: </summary>
<details> <summary> Build Steps </summary>

<p>

1. Download this Repo, and then open the `Easydict.xcworkspace` file with [Xcode](https://developer.apple.com/xcode/) (note that it is not `Easydict.xcodeproj`).
1. Download this Repo, and then open the `Easydict.xcworkspace` file with [Xcode](https://developer.apple.com/xcode/) (note that it is not `Easydict.xcodeproj` ⚠️⚠️⚠️).
2. Use `Cmd + R` to compile and run.

![image-20231212125308372](https://raw.githubusercontent.com/tisfeng/ImageBed/main/uPic/image-20231212125308372-1702356789.png)

The following steps are optional and intended for development collaborators only.

For development collaborators who want to run under their own Apple account, change DEVELOPMENT_TEAM in the Easydict-debug.xcconfig file to your own Apple Team ID (you can find it by logging in to the Apple developer website) and CODE_SIGN_IDENTITY to Apple Development.
If you often need to debug permission-related features, such as word fetching or OCR, you can choose to run it with your own Apple account, change DEVELOPMENT_TEAM in the Easydict-debug.xcconfig file to your own Apple Team ID (you can find it by logging in to the Apple developer website) and CODE_SIGN_IDENTITY to Apple Development.

Be careful not to commit the Easydict-debug.xcconfig file; you can ignore local changes to this file with the following git command
⚠️ Be careful not to commit the Easydict-debug.xcconfig file; you can ignore local changes to this file with the following git command

```bash
git update-index --skip-worktree Easydict-debug.xcconfig
```



Build environment: Xcode 13+, macOS Big Sur 11.3+. To avoid unnecessary problems, it is recommended to use the latest Xcode and macOS version https://github.com/tisfeng/Easydict/issues/79
#### Build Environment
Xcode 13+, macOS Big Sur 11.3+. To avoid unnecessary problems, it is recommended to use the latest Xcode and macOS version https://github.com/tisfeng/Easydict/issues/79

> [!NOTE]
> Since the latest code uses the String Catalog feature, Xcode 15+ is required to compile.
Expand Down

0 comments on commit 6cfee60

Please sign in to comment.