Skip to content

Commit

Permalink
docs(Readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
Ji4n1ng committed Jan 9, 2020
1 parent 0586e2f commit 49ebb41
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 85 deletions.
83 changes: 36 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<img width="100%" src="./Resources/screenshots/readme-header.png"><br/><br/>
<a href="https://github.com/Ji4n1ng/OpenInTerminal/releases/tag/2.0.5"><img src="https://img.shields.io/badge/Version-2.0.5-blue.svg?longCache=true&style=for-the-badge"></a>
<a href="https://github.com/Ji4n1ng/OpenInTerminal/releases/tag/2.1.1"><img src="https://img.shields.io/badge/Version-2.1.1-blue.svg?longCache=true&style=for-the-badge"></a>
<a href="https://github.com/Ji4n1ng/OpenInTerminal/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MIT-green.svg?longCache=true&style=for-the-badge"></a>
<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>
Expand All @@ -10,8 +10,6 @@ English | [OpenInTerminal 中文说明](./Resources/README-zh.md)

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

> HELP WANTED! Recently I have a signature problem with the version `2.1.0`. Please see [#61](https://github.com/Ji4n1ng/OpenInTerminal/issues/61). Thanks a lot!
## How to use 🚀

| Features | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
Expand All @@ -25,7 +23,7 @@ English | [OpenInTerminal 中文说明](./Resources/README-zh.md)
| Features | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
| --- | --- | --- |
| Support Terminal, [iTerm](https://www.iterm2.com/), [Hyper](https://github.com/zeit/hyper) and [Alacritty](https://github.com/jwilm/alacritty). |||
| Support [Visual Studio Code](https://code.visualstudio.com/), [VSCode Insiders](https://code.visualstudio.com/insiders/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/), [VSCodium](https://github.com/VSCodium/vscodium), [BBEdit](https://www.barebones.com/products/bbedit/) and [TextMate](https://macromates.com). |||
| Support [Visual Studio Code](https://code.visualstudio.com/), [VSCode Insiders](https://code.visualstudio.com/insiders/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/), [VSCodium](https://github.com/VSCodium/vscodium), [BBEdit](https://www.barebones.com/products/bbedit/), [TextMate](https://macromates.com), [CotEditor](https://coteditor.com/) and [MacVim](https://github.com/macvim-dev/macvim). |||
| Set to open a new tab or window. |||
| Support English, Chinese and French. |||
| GUI preferences |||
Expand All @@ -35,9 +33,9 @@ English | [OpenInTerminal 中文说明](./Resources/README-zh.md)

## OpenInTerminal and OpenInTerminal-Lite (OpenInEditor-Lite) 👀

Which one to choose? Both of these apps are my children. If you like more powerful features and GUI preferences, then you can use `OpenInTerminal`. If you just need to open terminal or editor and don't want to keep the application in the background, then you can use `OpenInTerminal-Lite`.
Which one to choose? Both of these apps are my children. If you like more powerful features and GUI preferences, then you can use `OpenInTerminal`. If you just need to open terminal faster and more stably, then you can use `OpenInTerminal-Lite`.

For me, I prefer the Lite version, which only needs to click once to complete the function (and the other needs to click twice 😂), and it is more lightweight.
For me, I prefer `OpenInTerminal-Lite` which only needs to click once to complete the function (and the other needs to click twice 😂) and it is more lightweight.

For `OpenInTerminal-Lite` users:

Expand All @@ -47,13 +45,13 @@ Please check the document: [OpenInTerminal-Lite English](./Resources/README-Lite

### 1. Download

#### a) Homebrew (current version: 2.0.5)
#### a) Homebrew (current version: 2.1.1)

```
brew cask install openinterminal
```

#### b) Manual (latest version: 2.0.5)
#### b) Manual (latest version: 2.1.1)

1. Download from [release](https://github.com/Ji4n1ng/OpenInTerminal/releases).

Expand All @@ -69,35 +67,18 @@ Open the OpenInTerminal app. Go to `System Preferences` -> `Extensions` -> `Find
<img src="./Resources/screenshots/finder-extension-permission.png" width="450px">
</div>

### 3. Set OpenInTerminal to launch at login

Just check the `Launch OpenInTerminal at login` button in `Preferences`.

> Because the Finder Extension does not work when the main app is not running, it is very recommended to set OpenInTerminal to launch at login.
<div>
<img src="./Resources/screenshots/pref-general.png" width="400px">
</div>

## Todo 👨‍💻

If you have a good idea, feel welcome to open a new [issue](https://github.com/Ji4n1ng/OpenInTerminal/issues/new/choose).

## Upcoming Features 🎉

🎉 OpenInTerminal finally supports Finder Extersion Standalone Operation Mode in version 2.1.0. It is not necessary to run OpenInTerminal in the background.

- Finder Extension Standalone Operation Mode.
- Finder context menu title will change to the current default terminal / editor.
- Open iTerm with split pane.
- Open iTerm in split pane
- Custom 'Open in Application'
- Fix: open multiple selected files in editor
- Custom Context Menu

## Support ❤️

Hello, I am Ji4n1ng. I am a student and OpenInTerminal is an open source project I maintain in my spare time. It is free and open source.

Recently because of strange bugs, signed OpenInTerminal(new version 2.1.0) cannot run on other computers. I don't know why. I will be very grateful that you can support me in purchasing an Apple Developer account ($99 is not a small number for students, it is close to my three-week living expenses.).

Or someone can help me solve this problem. Please see [#61](https://github.com/Ji4n1ng/OpenInTerminal/issues/61). Thanks a lot!
Hello, I am Ji4n1ng. I am a student and OpenInTerminal is an open source project I maintain in my spare time. It is free and open source. I will be very grateful that you can support me in purchasing an Apple Developer account. $99/year is not a small expense for students. It's close to my three-week living expenses. Thanks a lot!

| PayPal | AliPay | WeChat Pay |
| --- | --- | --- |
Expand All @@ -106,42 +87,50 @@ Or someone can help me solve this problem. Please see [#61](https://github.com/J
## FAQ ❓

<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>
<p>OpenInTerminal currently has a normal version and a lite version. If you like more powerful features and GUI preferences, then you can use OpenInTerminal. If you just need to open terminal faster and more stably, then you can use OpenInTerminal-Lite.</p>
</details>

<details><summary>3. I accidentally clicked on the <code>Don't Allow</code> button.</summary><br>
<details><summary>2. 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>4. Special characters in the <code>path</code>.</summary><br>
<details><summary>3. 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>

<details><summary>5. Open two Terminal windows on Mojave</summary><br>
<details><summary>4. Open two Terminal windows on Mojave</summary><br>
<p>This problem usually occurs when Terminal is first started. So you can use <code>⌘W</code> to close Terminal window instead of using <code>⌘Q</code> to quit Terminal.</p>
</details>

## Changes 🗒

**version 2.0.5**
<details><summary>5. Finder Extension Standalone Operation Mode</summary><br>
<p>Currently Finder extension is completely dependent on AppleScript in order to run independently. So it is hard to guarantee its stability. When you find that Finder extension doesn't work properly, you need to hold down the <code>Option(⌥)</code> key, right-click on Finder, and select <code>Relaunch</code>.</p>
</details>

- Fix: check application exist bug
## Changes 🗒

**version 2.0.4**
**version 2.1.1**

- Support TextMate
- Fix: keyboard shortcut bug
- Signed the application with the developer account. Bundle ID has changed.
- Support Finder Extension Standalone Operation Mode.
- Support CotEditor and MacVim.
- User can hide context menu items.
- Finder context menu item's title will change to the current default terminal / editor.

**version 2.0.3**
**version 2.0.5**

- Fix: Finder context menu icon supports dark mode
- Fix: check application exist bug

<details><summary>old version</summary><br>
<p><strong>version 2.0.4</strong></p>
<ul>
<li>Support TextMate</li>
<li>Fix: keyboard shortcut bug</li>
</ul>
<p><strong>version 2.0.3</strong></p>
<ul>
<li>Fix: Finder context menu icon supports dark mode</li>
</ul>
<p><strong>version 2.0.2</strong></p>
<ul>
<li>Support Visual Studio Code - Insiders</li>
Expand Down
52 changes: 14 additions & 38 deletions Resources/README-zh.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<img width="100%" src="./screenshots/readme-header-zh.png"><br/><br/>
<a href="https://github.com/Ji4n1ng/OpenInTerminal/releases/tag/2.0.5"><img src="https://img.shields.io/badge/Version-2.0.5-blue.svg?longCache=true&style=for-the-badge"></a>
<a href="https://github.com/Ji4n1ng/OpenInTerminal/releases/tag/2.1.1"><img src="https://img.shields.io/badge/Version-2.1.1-blue.svg?longCache=true&style=for-the-badge"></a>
<a href="https://github.com/Ji4n1ng/OpenInTerminal/blob/master/LICENSE"><img src="https://img.shields.io/badge/License-MIT-green.svg?longCache=true&style=for-the-badge"></a>
<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>
Expand All @@ -10,8 +10,6 @@

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

> 需要你的帮助!最近我签名 2.1.0 版本时,遇到了一个签名问题。请看 [#61](https://github.com/Ji4n1ng/OpenInTerminal/issues/61)。非常感谢!
## 如何使用 🚀

| 功能 | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
Expand All @@ -25,7 +23,7 @@
| 功能 | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
| --- | --- | --- |
| 支持 Terminal, [iTerm](https://www.iterm2.com/), [Hyper](https://github.com/zeit/hyper)[Alacritty](https://github.com/jwilm/alacritty). |||
| 支持 [Visual Studio Code](https://code.visualstudio.com/), [VSCode Insiders](https://code.visualstudio.com/insiders/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/), [VSCodium](https://github.com/VSCodium/vscodium), [BBEdit](https://www.barebones.com/products/bbedit/)[TextMate](https://macromates.com). |||
| 支持 [Visual Studio Code](https://code.visualstudio.com/), [VSCode Insiders](https://code.visualstudio.com/insiders/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/), [VSCodium](https://github.com/VSCodium/vscodium), [BBEdit](https://www.barebones.com/products/bbedit/)[TextMate](https://macromates.com)[CotEditor](https://coteditor.com/)[MacVim](https://github.com/macvim-dev/macvim) |||
| 设置为打开新的窗口或者标签页 |||
| 支持中文,英语和法语 |||
| 图形化设置界面 |||
Expand All @@ -35,9 +33,9 @@

## OpenInTerminal 和 OpenInTerminal-Lite (OpenInEditor-Lite) 👀

选择哪个?这两个应用都是我的孩子。如果你喜欢更强大的功能和图形化设置界面,那么你可以选择 `OpenInTerminal`如果你仅仅需要打开终端或编辑器而不需要应用一直常驻后台,那么你可以选择 `OpenInTerminal-Lite`
选择哪个?这两个应用都是我的孩子。如果你喜欢更强大的功能和图形化设置界面,那么你可以选择 `OpenInTerminal`如果你仅仅需要更快速且更稳定地打开终端或编辑器,那么你可以选择 `OpenInTerminal-Lite`

对于我而言,我更喜欢 `OpenInTerminal-Lite`,它只需要点击一次来完成功能(另一个需要点击两次😂),而且更轻量一些
对于我而言,我更喜欢 `OpenInTerminal-Lite`,它只需要点击一次来完成功能(另一个需要点击两次😂),而且它更轻量一些

对于 `OpenInTerminal-Lite` 用户:

Expand All @@ -47,13 +45,13 @@

### 1. 下载

#### a) Homebrew (当前版本:2.0.5)
#### a) Homebrew (当前版本:2.1.1)

```
brew cask install openinterminal
```

#### b) 手动 (最新版本:2.0.5)
#### b) 手动 (最新版本:2.1.1)

1.[release](https://github.com/Ji4n1ng/OpenInTerminal/releases) 中下载。
2. 将应用移动到 `应用程序` 文件夹。
Expand All @@ -68,31 +66,9 @@ brew cask install openinterminal
<img src="./screenshots/finder-extension-permission-zh.png" width="450px">
</div>

### 3. 将 OpenInTerminal 设置为开机启动

勾选 `偏好设置` 中的 `自动启动` 按钮即可。

> 如果 OpenInTerminal 主应用不运行, Finder 扩展将不会工作。所以更推荐将 OpenInTerminal 设置为自动启动。
<div>
<img src="./screenshots/pref-general-zh.png" width="400px">
</div>

## 即将到来的功能 🎉

🎉 OpenInTerminal 版本 2.1.0 终于支持访达扩展独立运行了。不需要让 OpenInTerminal 运行在后台。

- 访达扩展独立运行模式。
- 访达右键菜单根据当前设置的默认终端或者编辑器来更改标题。
- 打开 iTerm 时,新建一个分割的窗格。

## 支持 ❤️

你好,我是 Ji4n1ng。我是一名学生,OpenInTerminal 是我空余时间维护的一个开源项目。它是免费且开源的。

最近由于奇怪的 bug,签名过的 OpenInTerminal 不能在其他 Mac 上运行。我不明白什么原因。如果你能支持我购买苹果开发者证书,我将非常感激。(99美元对于学生来说,并不是一个小的数字,它几乎是我三个星期的生活费。)

或者,有人能帮我解决这个问题也可以。请看 [#61](https://github.com/Ji4n1ng/OpenInTerminal/issues/61)。非常感谢!
你好,我是 Ji4n1ng。我是一名学生,OpenInTerminal 是我空余时间维护的一个开源项目。它是免费且开源的。如果你能支持我购买苹果开发者账号,我将非常感激。一年 99 美元的花费对于学生来说,并不是一个小的数字,它几乎是我三个星期的生活费。

| PayPal | 支付宝 | 微信 |
| --- | --- | --- |
Expand All @@ -104,23 +80,23 @@ brew cask install openinterminal
<p>OpenInTerminal 目前有正常版和 Lite 版。如果你仅仅需要打开终端而且不需要应用一直常驻后台,那么你可以选择 Lite 版。如果你喜欢更强大的功能,那么你可以选择正常版。</p>
</details>

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

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

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

<details><summary>5. 在 Mojave 上打开了两个终端窗口</summary><br>
<details><summary>4. 在 Mojave 上打开了两个终端窗口</summary><br>
<p>这个问题只发生在第一次启动终端的时候。所以,你可以通过 <code>⌘W</code> 来关闭终端的窗口,而不是用 <code>⌘Q</code> 来退出终端。</p>
</details>

<details><summary>5. 访达扩展独立运行模式</summary><br>
<p>访达扩展目前完全依赖于 AppleScript 以便于能够独立运行。所以很难保证它的稳定性。当你发现访达扩展不能正常工作的时候,你需要按住 <code>Option(⌥)</code> 键,右键点击访达并选择 <code>重启</code>。</p>
</details>

## 特别感谢 ❤️

### 贡献者
Expand Down

0 comments on commit 49ebb41

Please sign in to comment.