Skip to content

Commit 49ebb41

Browse files
committed
docs(Readme): update
1 parent 0586e2f commit 49ebb41

File tree

2 files changed

+50
-85
lines changed

2 files changed

+50
-85
lines changed

README.md

Lines changed: 36 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<img width="100%" src="./Resources/screenshots/readme-header.png"><br/><br/>
3-
<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>
3+
<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>
44
<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>
55
<img src="https://img.shields.io/badge/Made With-Swift-red.svg?longCache=true&style=for-the-badge">
66
<a href="https://travis-ci.org/Ji4n1ng/OpenInTerminal"><img src="https://img.shields.io/travis/Ji4n1ng/OpenInTerminal.svg?style=for-the-badge"></a>
@@ -10,8 +10,6 @@ English | [OpenInTerminal 中文说明](./Resources/README-zh.md)
1010

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

13-
> 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!
14-
1513
## How to use 🚀
1614

1715
| Features | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
@@ -25,7 +23,7 @@ English | [OpenInTerminal 中文说明](./Resources/README-zh.md)
2523
| Features | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
2624
| --- | --- | --- |
2725
| Support Terminal, [iTerm](https://www.iterm2.com/), [Hyper](https://github.com/zeit/hyper) and [Alacritty](https://github.com/jwilm/alacritty). |||
28-
| 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). |||
26+
| 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). |||
2927
| Set to open a new tab or window. |||
3028
| Support English, Chinese and French. |||
3129
| GUI preferences |||
@@ -35,9 +33,9 @@ English | [OpenInTerminal 中文说明](./Resources/README-zh.md)
3533

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

38-
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`.
36+
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`.
3937

40-
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.
38+
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.
4139

4240
For `OpenInTerminal-Lite` users:
4341

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

4846
### 1. Download
4947

50-
#### a) Homebrew (current version: 2.0.5)
48+
#### a) Homebrew (current version: 2.1.1)
5149

5250
```
5351
brew cask install openinterminal
5452
```
5553

56-
#### b) Manual (latest version: 2.0.5)
54+
#### b) Manual (latest version: 2.1.1)
5755

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

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

72-
### 3. Set OpenInTerminal to launch at login
73-
74-
Just check the `Launch OpenInTerminal at login` button in `Preferences`.
75-
76-
> 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.
77-
78-
<div>
79-
<img src="./Resources/screenshots/pref-general.png" width="400px">
80-
</div>
81-
8270
## Todo 👨‍💻
8371

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

86-
## Upcoming Features 🎉
87-
88-
🎉 OpenInTerminal finally supports Finder Extersion Standalone Operation Mode in version 2.1.0. It is not necessary to run OpenInTerminal in the background.
89-
90-
- Finder Extension Standalone Operation Mode.
91-
- Finder context menu title will change to the current default terminal / editor.
92-
- Open iTerm with split pane.
74+
- Open iTerm in split pane
75+
- Custom 'Open in Application'
76+
- Fix: open multiple selected files in editor
77+
- Custom Context Menu
9378

9479
## Support ❤️
9580

96-
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.
97-
98-
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.).
99-
100-
Or someone can help me solve this problem. Please see [#61](https://github.com/Ji4n1ng/OpenInTerminal/issues/61). Thanks a lot!
81+
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!
10182

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

10889
<details><summary>1. What is the difference between OpenInTerminal and OpenInTerminal-Lite?</summary><br>
109-
<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>
110-
</details>
111-
112-
<details><summary>2. Finder Extension doesn't work</summary><br>
113-
<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>
90+
<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>
11491
</details>
11592

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

121-
<details><summary>4. Special characters in the <code>path</code>.</summary><br>
98+
<details><summary>3. Special characters in the <code>path</code>.</summary><br>
12299
<p>Please do not use backslash <code>\</code> and double quotes <code>"</code> in the path.</p>
123100
</details>
124101

125-
<details><summary>5. Open two Terminal windows on Mojave</summary><br>
102+
<details><summary>4. Open two Terminal windows on Mojave</summary><br>
126103
<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>
127104
</details>
128105

129-
## Changes 🗒
130-
131-
**version 2.0.5**
106+
<details><summary>5. Finder Extension Standalone Operation Mode</summary><br>
107+
<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>
108+
</details>
132109

133-
- Fix: check application exist bug
110+
## Changes 🗒
134111

135-
**version 2.0.4**
112+
**version 2.1.1**
136113

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

140-
**version 2.0.3**
120+
**version 2.0.5**
141121

142-
- Fix: Finder context menu icon supports dark mode
122+
- Fix: check application exist bug
143123

144124
<details><summary>old version</summary><br>
125+
<p><strong>version 2.0.4</strong></p>
126+
<ul>
127+
<li>Support TextMate</li>
128+
<li>Fix: keyboard shortcut bug</li>
129+
</ul>
130+
<p><strong>version 2.0.3</strong></p>
131+
<ul>
132+
<li>Fix: Finder context menu icon supports dark mode</li>
133+
</ul>
145134
<p><strong>version 2.0.2</strong></p>
146135
<ul>
147136
<li>Support Visual Studio Code - Insiders</li>

Resources/README-zh.md

Lines changed: 14 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
22
<img width="100%" src="./screenshots/readme-header-zh.png"><br/><br/>
3-
<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>
3+
<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>
44
<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>
55
<img src="https://img.shields.io/badge/Made With-Swift-red.svg?longCache=true&style=for-the-badge">
66
<a href="https://travis-ci.org/Ji4n1ng/OpenInTerminal"><img src="https://img.shields.io/travis/Ji4n1ng/OpenInTerminal.svg?style=for-the-badge"></a>
@@ -10,8 +10,6 @@
1010

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

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

1715
| 功能 | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
@@ -25,7 +23,7 @@
2523
| 功能 | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite |
2624
| --- | --- | --- |
2725
| 支持 Terminal, [iTerm](https://www.iterm2.com/), [Hyper](https://github.com/zeit/hyper)[Alacritty](https://github.com/jwilm/alacritty). |||
28-
| 支持 [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). |||
26+
| 支持 [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) |||
2927
| 设置为打开新的窗口或者标签页 |||
3028
| 支持中文,英语和法语 |||
3129
| 图形化设置界面 |||
@@ -35,9 +33,9 @@
3533

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

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

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

4240
对于 `OpenInTerminal-Lite` 用户:
4341

@@ -47,13 +45,13 @@
4745

4846
### 1. 下载
4947

50-
#### a) Homebrew (当前版本:2.0.5)
48+
#### a) Homebrew (当前版本:2.1.1)
5149

5250
```
5351
brew cask install openinterminal
5452
```
5553

56-
#### b) 手动 (最新版本:2.0.5)
54+
#### b) 手动 (最新版本:2.1.1)
5755

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

71-
### 3. 将 OpenInTerminal 设置为开机启动
72-
73-
勾选 `偏好设置` 中的 `自动启动` 按钮即可。
74-
75-
> 如果 OpenInTerminal 主应用不运行, Finder 扩展将不会工作。所以更推荐将 OpenInTerminal 设置为自动启动。
76-
77-
<div>
78-
<img src="./screenshots/pref-general-zh.png" width="400px">
79-
</div>
80-
81-
## 即将到来的功能 🎉
82-
83-
🎉 OpenInTerminal 版本 2.1.0 终于支持访达扩展独立运行了。不需要让 OpenInTerminal 运行在后台。
84-
85-
- 访达扩展独立运行模式。
86-
- 访达右键菜单根据当前设置的默认终端或者编辑器来更改标题。
87-
- 打开 iTerm 时,新建一个分割的窗格。
88-
8969
## 支持 ❤️
9070

91-
你好,我是 Ji4n1ng。我是一名学生,OpenInTerminal 是我空余时间维护的一个开源项目。它是免费且开源的。
92-
93-
最近由于奇怪的 bug,签名过的 OpenInTerminal 不能在其他 Mac 上运行。我不明白什么原因。如果你能支持我购买苹果开发者证书,我将非常感激。(99美元对于学生来说,并不是一个小的数字,它几乎是我三个星期的生活费。)
94-
95-
或者,有人能帮我解决这个问题也可以。请看 [#61](https://github.com/Ji4n1ng/OpenInTerminal/issues/61)。非常感谢!
71+
你好,我是 Ji4n1ng。我是一名学生,OpenInTerminal 是我空余时间维护的一个开源项目。它是免费且开源的。如果你能支持我购买苹果开发者账号,我将非常感激。一年 99 美元的花费对于学生来说,并不是一个小的数字,它几乎是我三个星期的生活费。
9672

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

107-
<details><summary>2. Finder 扩展不工作了</summary><br>
108-
<p>请检查 OpenInTerminal(主应用)的图标是否在菜单栏中。因为 Finder 扩展会一直在 Finder 工具栏中,所以当主应用不运行时 Finder 扩展无法工作。推荐在偏好设置中将 OpenInTerminal 设置为自动启动。</p>
109-
</details>
110-
111-
<details><summary>3. 我不小心点了不授权的按钮</summary><br>
83+
<details><summary>2. 我不小心点了不授权的按钮</summary><br>
11284
<p>你可以运行以下命令。这会重置系统设置里的权限。</p>
11385
<pre><code>tccutil reset AppleEvents</code></pre>
11486
</details>
11587

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

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

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

126102
### 贡献者

0 commit comments

Comments
 (0)