Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tisfeng committed Nov 16, 2023
1 parent ac05001 commit 90230ad
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 16 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,13 +117,16 @@ brew install easydict
<p>

1. 下载这个 Repo,然后使用 [Xcode](https://developer.apple.com/xcode/) 打开 `Easydict.xcworkspace` 文件(注意不是 `Easydict.xcodeproj`)。
2. 将 Easydict-debug.xcconfig 文件中的 DEVELOPMENT_TEAM 改为你自己的 Apple Team ID(你可以登录苹果开发者网站找到它),或者将 DEVELOPMENT_TEAM 和 CODE_SIGN_IDENTITY 的值设置为空。(注意,PR 时不要提交 Easydict-debug.xcconfig 文件)
3. 使用 `Cmd + R` 编译运行即可。
2. 使用 `Cmd + R` 编译运行即可。

```
DEVELOPMENT_TEAM = 79NQA2XYHM
CODE_SIGN_IDENTITY = Apple Development
CODE_SIGN_STYLE = Automatic


对于开发协作者,如果想使用自己的苹果账号运行,请修改 Easydict-debug.xcconfig 文件中的 DEVELOPMENT_TEAM 为你自己的 Apple Team ID(你可以登录苹果开发者网站找到它),CODE_SIGN_IDENTITY 改为 Apple Development。

注意不要提交 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
Expand Down Expand Up @@ -479,7 +482,7 @@ easydict://writeKeyValue?Youdao-IntelligentQueryTextType=2
```
easydict://writeKeyValue?IntelligentQueryMode-window2=1
```
window1 代表迷你窗口,window2 代表侧悬浮窗口,后面的 0 表示关闭,1 表示开启。
window1 代表迷你窗口,window2 代表侧悬浮窗口,赋值 0 表示关闭,1 表示开启。
> [!NOTE]
> 智能查询模式,只表示是否智能启用该查询服务,用户可随时手动点击服务右侧箭头按钮展开查询。
Expand All @@ -505,7 +508,8 @@ Easydict 支持 URL scheme 快速查询:`easydict://query?text=xxx`,如 easy
如果查询内容 xxx 包含特殊字符,需进行 URL encode,如 easydict://query?text=good%20girl
> [!WARNING]
> 旧版本的 easydict://xxx 在某些场景下可能会出现问题,因此建议使用完整的 URL Scheme easydict://query?text=xxx
> 旧版本的 easydict://xxx 在某些场景下可能会出现问题,因此建议使用完整的 URL Scheme:
> easydict://query?text=xxx
## 配合 PopClip 使用
Expand Down
23 changes: 15 additions & 8 deletions README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,14 +116,19 @@ If you are a developer, or you are interested in this project, you can also try
<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`).
2. Change the DEVELOPMENT_TEAM in the Easydict-debug.xcconfig file to your own Apple Team ID (you can find it by logging into the Apple Developer website), or set the values of DEVELOPMENT_TEAM and CODE_SIGN_IDENTITY to empty.
3. Use `Cmd + R` to compile and run.
2. Use `Cmd + R` to compile and run.



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.

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
```
DEVELOPMENT_TEAM = 79NQA2XYHM
CODE_SIGN_IDENTITY = Apple Development
CODE_SIGN_STYLE = Automatic
```



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

Expand Down Expand Up @@ -478,7 +483,7 @@ By default, only [Mini Window] is enabled for Smart Query Mode, users can also e
```
easydict://writeKeyValue?IntelligentQueryMode-window2=1
```
window1 represents the mini window, while window2 represents hover window, 0 represents disabled, while 1 represents enabled.
window1 represents the mini window, while window2 represents hover window, value 0 represents disabled, while 1 represents enabled.
> [!NOTE]
> Smart query mode only indicates whether this query service is enabled or not, and the user can manually click on the arrow to the right in the service view to expand the query at any time.
Expand All @@ -503,7 +508,9 @@ Easydict supports fast lookup for URL scheme: `easydict://query?text=xxx`, such
If the query content xxx contains special characters, URL encoding is needed, such as easydict://query?text=good%20girl
> [!WARNING]
> The old version of easydict://xxx may cause problems in some scenarios, so it is recommended to use the complete URL Scheme easydict://query?text=xxx
> The old version of easydict://xxx may cause problems in some scenarios, so it is recommended to use the complete URL Scheme:
>
> easydict://query?text=xxx
## Use with PopClip
Expand Down

0 comments on commit 90230ad

Please sign in to comment.