Skip to content

Commit

Permalink
docs(Readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
Ji4n1ng committed May 6, 2019
1 parent 85fc8fb commit abf6825
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 20 deletions.
5 changes: 1 addition & 4 deletions README-Lite-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
<img src="https://img.shields.io/badge/Made With-Swift-red.svg?longCache=true&style=for-the-badge">
<a href="https://travis-ci.org/Ji4n1ng/OpenInTerminal"><img src="https://img.shields.io/travis/Ji4n1ng/OpenInTerminal.svg?style=for-the-badge"></a>
</p>

[English](./README-Lite.md) | 中文说明

## 如何使用 🚀
Expand Down Expand Up @@ -70,8 +69,6 @@ defaults write wang.jianing.OpenInTerminal-Lite OIT_iTermNewOption "window"

## 如何安装 🖥

> 因为更新较为频繁,所以更推荐手动下载最新版本
### 手动安装 (最新版本:0.4.1)

1.[release](https://github.com/Ji4n1ng/OpenInTerminal/releases) 中下载。
Expand All @@ -81,7 +78,7 @@ defaults write wang.jianing.OpenInTerminal-Lite OIT_iTermNewOption "window"

![toolbar](./screenshots/lite-drag_to_toolbar.gif)

### Homebrew (最新版本:0.4.0)
### Homebrew (最新版本:0.4.1)

1. 运行以下命令

Expand Down
4 changes: 1 addition & 3 deletions README-Lite.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ For `Alacritty` users, it is only supported to open a new window now.

## How to install 🖥

> Because updates are frequent, it is recommended to manually download the latest version.
### Manual (latest version: 0.4.1)

1. Download from [release](https://github.com/Ji4n1ng/OpenInTerminal/releases).
Expand All @@ -81,7 +79,7 @@ For `Alacritty` users, it is only supported to open a new window now.

![toolbar](./screenshots/lite-drag_to_toolbar.gif)

### Homebrew (current version 0.4.0)
### Homebrew (latest version 0.4.1)

1. Run the following command

Expand Down
28 changes: 22 additions & 6 deletions README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,27 @@
- ✅ 从菜单栏快速启动指定动作
- ✅ 支持 Dark Mode

### 我仍然想用 OpenInTerminal-Lite
## OpenInTerminal 和 OpenInTerminal-Lite 👀

OpenInTerminal 目前有正常版和 Lite 版。如果你仅仅需要打开终端而且不需要应用一直常驻后台,那么你可以选择 `OpenInTerminal-Lite` 版。如果你喜欢更强大的功能,那么你可以选择`OpenInTerminal`

对于 `OpenInTerminal-Lite` 用户:

请看文档: [English](./README-Lite.md) | [中文说明](README-Lite-zh.md)

## 如何安装 🖥

### 1. 下载

#### a) Homebrew (即将支持)
#### a) Homebrew (最新版本:0.9.0)

1. 运行以下命令。

```
brew cask install openinterminal
```

2. 完成。

#### b) 手动 (最新版本:0.9.0)

Expand All @@ -56,7 +68,7 @@
### 2. 打开 Finder 扩展权限

`系统偏好设置` -> `扩展` -> `访达扩展`,打开下图中的权限按钮。
打开 OpenInTerminal 应用。`系统偏好设置` -> `扩展` -> `访达扩展`,打开下图中的权限按钮。

<div>
<img src="./screenshots/finder-extension-permission-zh.png" width="450px">
Expand All @@ -74,16 +86,20 @@

## 常见问题 ❓

<details><summary>1. Finder 扩展不工作了</summary><br>
<details><summary>1. OpenInTerminal 和 OpenInTerminal-Lite 的区别是什么?</summary><br>
<p>OpenInTerminal 目前有正常版和 Lite 版。如果你仅仅需要打开终端而且不需要应用一直常驻后台,那么你可以选择 Lite 版。如果你喜欢更强大的功能,那么你可以选择正常版。</p>
</details>

<details><summary>2. Finder 扩展不工作了</summary><br>
<p>请检查 OpenInTerminal(主应用)的图标是否在菜单栏中。因为 Finder 扩展会一直在 Finder 工具栏中,所以当主应用不运行时 Finder 扩展无法工作。推荐在偏好设置中将 OpenInTerminal 设置为自动启动。</p>
</details>

<details><summary>2. 我不小心点了不授权的按钮</summary><br>
<details><summary>3. 我不小心点了不授权的按钮</summary><br>
<p>你可以运行以下命令。这会重置系统设置里的权限。</p>
<pre><code>tccutil reset AppleEvents</code></pre>
</details>

<details><summary>3. 路径里的特殊字符</summary><br>
<details><summary>4. 路径里的特殊字符</summary><br>
<p>请不要在路径中使用反斜线 <code>\</code> 和双引号 <code>"</code>。</p>
</details>

Expand Down
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
<a href="https://travis-ci.org/Ji4n1ng/OpenInTerminal"><img src="https://img.shields.io/travis/Ji4n1ng/OpenInTerminal.svg?style=for-the-badge"></a>
</p>


English | [中文说明](./README-zh.md)

## How to use 🚀
Expand Down Expand Up @@ -37,15 +36,27 @@ English | [中文说明](./README-zh.md)
- ✅ Quick toggle the specified action from Menu bar.
- ✅ Support Dark Mode.

### I still want to use OpenInTerminal-Lite
## OpenInTerminal and OpenInTerminal-Lite 👀

There are a normal version and a lite version of OpenInTerminal. If you only need to open the terminal and don't need to keep the application in the background, then you can use `OpenInTerminal-Lite`. If you like more powerful features, then you can use `OpenInTerminal`.

For `OpenInTerminal-Lite` users:

Please check the document: [English](./README-Lite.md) | [中文说明](README-Lite-zh.md)

## How to install 🖥

### 1. Download

#### a) Homebrew (come soon)
#### a) Homebrew (latest version: 0.9.0)

1. Run the following command.

```
brew cask install openinterminal
```

2. Done.

#### b) Manual (latest version: 0.9.0)

Expand All @@ -59,7 +70,7 @@ Please check the document: [English](./README-Lite.md) | [中文说明](README-L
### 2. Check Finder Extension permission

Go to `System Preferences` -> `Extensions` -> `Finder Extensions`, check the permission button as below.
Open the OpenInTerminal app. Go to `System Preferences` -> `Extensions` -> `Finder Extensions`, check the permission button as below.

<div>
<img src="./screenshots/finder-extension-permission.png" width="450px">
Expand All @@ -84,16 +95,20 @@ If you have a good idea, feel welcome to open a new [issue](https://github.com/J

## FAQ ❓

<details><summary>1. Finder Extension doesn't work</summary><br>
<details><summary>1. What is the difference between OpenInTerminal and OpenInTerminal-Lite?</summary><br>
<p>OpenInTerminal currently has a normal version and a lite version. If you only need to open the terminal and don't need to keep the application in the background, then you can use the Lite version. If you like more powerful features, then choose the normal version. </p>
</details>

<details><summary>2. Finder Extension doesn't work</summary><br>
<p>Please check if there is an OpenInTerminal(main app) icon in the status bar. The Finder Extension will always be in the toolbar. But if the main app is not open, it will not work. It is recommended to set OpenInTerminal to launch at login in Preferences.</p>
</details>

<details><summary>2. I accidentally clicked on the <code>Don't Allow</code> button.</summary><br>
<details><summary>3. I accidentally clicked on the <code>Don't Allow</code> button.</summary><br>
<p>You can run the following command in the terminal. This will reset the permissions in the System Preferences.</p>
<br><code>tccutil reset AppleEvents</code><br>
</details>

<details><summary>3. Special characters in the <code>path</code>.</summary><br>
<details><summary>4. Special characters in the <code>path</code>.</summary><br>
<p>Please do not use backslash <code>\</code> and double quotes <code>"</code> in the path.</p>
</details>

Expand Down

0 comments on commit abf6825

Please sign in to comment.