From 985b716441318c5e9b5fb9f882ab61a0277e97c7 Mon Sep 17 00:00:00 2001 From: Ji4n1ng Date: Tue, 23 Jul 2019 17:02:37 +0800 Subject: [PATCH] docs(Readme): update --- README.md | 57 ++++++++++++++++++---------------------- Resources/README-Lite.md | 2 +- Resources/README-zh.md | 47 +++++++++++++++------------------ 3 files changed, 47 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index 78a3c5b..bc73828 100644 --- a/README.md +++ b/README.md @@ -6,45 +6,40 @@

-English | [中文说明](./Resources/README-zh.md) +English | [OpenInTerminal 中文说明](./Resources/README-zh.md) -## How to use 🚀 - -### 1) Open current directory in Terminal (or Editor) - -
- -
- -### 2) Open selected folder or file in Terminal (or Editor) - -
- -
+[OpenInTerminal-Lite English](./Resources/README-Lite.md) | [OpenInTerminal-Lite 中文说明](./Resources/README-Lite-zh.md) -### 3) Copy path of the selected file or Finder window to Clipboard +## How to use 🚀 -
- -
+| Features | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite | +| --- | --- | --- | +| Open current directory in Terminal (or Editor) | ![](./Resources/screenshots/main-open-in-terminal.gif) | ![](./Resources/screenshots/lite-run.gif) | +| Open selected folder or file in Terminal (or Editor) | ![](./Resources/screenshots/main-open-in-editor.gif) | ![](./Resources/screenshots/lite-run-editor.gif) | +| Copy path of the selected file or Finder window to Clipboard | ![](./Resources/screenshots/main-copy-path-to-clipboard.gif) | ❌ Not Supported | ### More features -- ✅ 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/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/), [VSCodium](https://github.com/VSCodium/vscodium) and [BBEdit](https://www.barebones.com/products/bbedit/). -- ✅ Set to open a new tab or window. -- ✅ Support keyboard shortcuts. -- ✅ Quick toggle the specified action from Menu bar. -- ✅ Support Dark Mode. -- ✅ Support English, Chinese and French. +| 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/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/), [VSCodium](https://github.com/VSCodium/vscodium) and [BBEdit](https://www.barebones.com/products/bbedit/). | ✅ | ✅ | +| Set to open a new tab or window. | ✅ | ✅ | +| Support English, Chinese and French. | ✅ | ✅ | +| GUI preferences | ✅ | ❌ | +| Support keyboard shortcuts. | ✅ | ❌ | +| Support Dark Mode. | ✅ | ❌ | +| No need to run in the background | ❌ | ✅ | ## OpenInTerminal and OpenInTerminal-Lite (OpenInEditor-Lite) 👀 -There are a normal version and a lite version of OpenInTerminal. 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 or editor and don't want to keep the application in the background, 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 `OpenInTerminal-Lite` users: -Please check the document: [English](./Resources/README-Lite.md) | [中文说明](./Resources/README-Lite-zh.md) +Please check the document: [OpenInTerminal-Lite English](./Resources/README-Lite.md) | [OpenInTerminal-Lite 中文说明](./Resources/README-Lite-zh.md) ## How to install 🖥 @@ -52,11 +47,9 @@ Please check the document: [English](./Resources/README-Lite.md) | [中文说明 #### a) Homebrew (current version: 2.0.1) -1. Run the following command. - - ``` - brew cask install openinterminal - ``` +``` +brew cask install openinterminal +``` 2. Done. diff --git a/Resources/README-Lite.md b/Resources/README-Lite.md index f58a46e..abfdd99 100644 --- a/Resources/README-Lite.md +++ b/Resources/README-Lite.md @@ -7,7 +7,7 @@

-English | [中文说明](README-Lite-zh.md) +English | [中文说明](./README-Lite-zh.md) ## How to use 🚀 diff --git a/Resources/README-zh.md b/Resources/README-zh.md index d77b2f5..e82e845 100644 --- a/Resources/README-zh.md +++ b/Resources/README-zh.md @@ -8,43 +8,38 @@ [English](../README.md) | 中文说明 -## 如何使用 🚀 - -### 1) 在终端（或编辑器）中打开当前目录 +[OpenInTerminal-Lite English](./README-Lite.md) | [OpenInTerminal-Lite 中文说明](./README-Lite-zh.md) -
- -
- -### 2) 在终端（或编辑器）中打开选择的文件夹或文件 - -
- -
- -### 3）将已选择的文件或者访达窗口的路径拷贝到粘贴板 +## 如何使用 🚀 -
- -
+| 功能 | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite | +| --- | --- | --- | +| 在终端（或编辑器）中打开当前目录 | ![](./screenshots/main-open-in-terminal.gif) | ![](./screenshots/lite-run.gif) | +| 在终端（或编辑器）中打开选择的文件夹或文件 | ![](./screenshots/main-open-in-editor.gif) | ![](./screenshots/lite-run-editor.gif) | +| 将已选择的文件或者访达窗口的路径拷贝到粘贴板 | ![](./screenshots/main-copy-path-to-clipboard.gif) | ❌ Not Supported | ### 更多功能 -- ✅ 支持 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/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/)，[VSCodium](https://github.com/VSCodium/vscodium) 和 [BBEdit](https://www.barebones.com/products/bbedit/). -- ✅ 设置为打开新的窗口或者标签页 -- ✅ 支持键盘快捷键 -- ✅ 从菜单栏快速启动指定动作 -- ✅ 支持 Dark Mode -- ✅ 支持中文，英语和法语 +| 功能 | OpenInTerminal | OpenInTerminal-Lite & OpenInEditor-Lite | +| --- | --- | --- | +| 支持 Terminal, [iTerm](https://www.iterm2.com/), [Hyper](https://github.com/zeit/hyper) and [Alacritty](https://github.com/jwilm/alacritty). | ✅ | ✅ | +| 支持 [Visual Studio Code](https://code.visualstudio.com/), [Atom](https://atom.io/), [Sublime Text](https://www.sublimetext.com/), [VSCodium](https://github.com/VSCodium/vscodium) and [BBEdit](https://www.barebones.com/products/bbedit/). | ✅ | ✅ | +| 设置为打开新的窗口或者标签页 | ✅ | ✅ | +| 支持中文，英语和法语 | ✅ | ✅ | +| 图形化设置界面 | ✅ | ❌ | +| 支持键盘快捷键 | ✅ | ❌ | +| 支持 Dark Mode | ✅ | ❌ | +| 不需要后台运行 | ❌ | ✅ | ## OpenInTerminal 和 OpenInTerminal-Lite (OpenInEditor-Lite) 👀 -OpenInTerminal 目前有正常版和 Lite 版。如果你喜欢更强大的功能和图形化设置界面，那么你可以选择`OpenInTerminal`。如果你仅仅需要打开终端或编辑器而不需要应用一直常驻后台，那么你可以选择 `OpenInTerminal-Lite` 版。 +选择哪个？这两个应用都是我的孩子。如果你喜欢更强大的功能和图形化设置界面，那么你可以选择 `OpenInTerminal`。如果你仅仅需要打开终端或编辑器而不需要应用一直常驻后台，那么你可以选择 `OpenInTerminal-Lite`。 + +对于我而言，我更喜欢 `OpenInTerminal-Lite`，它只需要点击一次来完成功能（另一个需要点击两次😂），而且更轻量一些。 对于 `OpenInTerminal-Lite` 用户： -请看文档： [English](./README-Lite.md) | [中文说明](README-Lite-zh.md) +请看文档： [English](./README-Lite.md) | [中文说明](./README-Lite-zh.md) ## 如何安装 🖥