Skip to content

Commit

Permalink
docs(Readme): add Readme & zh
Browse files Browse the repository at this point in the history
  • Loading branch information
Ji4n1ng committed Apr 12, 2019
1 parent e4c896b commit a90ec96
Show file tree
Hide file tree
Showing 8 changed files with 92 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README-zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# OpenInTerminal

一个可以在终端(或 iTerm)中打开当前目录的访达工具栏应用程序。

## 如何使用

### 1) 在终端中打开当前目录

![run](./screenshots/run.gif)

### 2) 在终端中打开选择的文件夹

![run2](./screenshots/run2.gif)

### 3) 其他

如果既没有打开访达窗口,也没有选中文件夹,那么程序将会在 `Terminal` 或者 `iTerm` 里打开 `Home` 目录。

## 如何安装

1.[release](https://github.com/Ji4n1ng/OpenInTerminal/releases) 中下载。
2. 将应用移动到 `应用程序` 文件夹.
3. 右键点击`访达`工具栏,选择`自定义工具栏`。将应用拖到工具栏中。
4. 完成。

> ⚠️ 当您第一次运行应用程序时,macOS 将要求访问 `访达``终端`(或 `iTerm`)的权限。请给予应用程序权限。
![toolbar](./screenshots/toolbar-zh.gif)

### 如果你正在使用深色模式 (Dark Mode)

我在 release 中提供了几个图标。 您可以右键单击该应用程序并选择 `显示简介`。 拖动图标进行更改。

![change_icon](./screenshots/change_icon-zh.gif)
58 changes: 58 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# OpenInTerminal

Finder Toolbar app for macOS to open the current directory in `Terminal` or `iTerm`.

[中文说明](https://github.com/Ji4n1ng/OpenInTerminal/README-zh.md)

## How to use

### 1) Open Current Directory from Toolbar

![run](./screenshots/run.gif)

### 2) Open Selected folder or file from Toolbar

![run2](./screenshots/run2.gif)

### 3) Other

If neither Finder window is opened nor the folder is selected, this app will open `home directory` in `Terminal` or `iTerm`.

## How to Install

1. Download from [release](https://github.com/Ji4n1ng/OpenInTerminal/releases).
2. Move the app into `/Applications`.
3. Right click on the Finder toolbar. Choose `Customize Toolbar`. Drag the app into Finder Toolbar.
4. Done.

> ⚠️ macOS will ask your permissions to access Finder and Terminal (or iTerm) when you run the app for the first time. Please give the application permissions.
![toolbar](./screenshots/toolbar.gif)

### If you are using Dark Mode

I provided several icons along with the app in the release. You can right click on the app and select `Get Info`. Drag the icon to change.

![change_icon](./screenshots/change_icon.gif)

## How to build

```
git clone https://github.com/Ji4n1ng/OpenInTerminal
cd OpenInTerminal
xcodebuild
```

> If you want to change default terminal, edit it in `main.swift`. I will try my best to solve this problem in a more elegant way.
## TODO

1. Dynamically change icon depending on Dark Mode.
2. User can choose which terminal to open.
3. Fix: If path include `\`, the app will crash when openning in iTerm.

## Special Thanks to

- [jbtule/cdto](https://github.com/jbtule/cdto)
- [es-kumagai/OpenTerminal](https://github.com/es-kumagai/OpenTerminal)
- [tingraldi/SwiftScripting](https://github.com/tingraldi/SwiftScripting)
Binary file added screenshots/change_icon-zh.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/change_icon.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/run.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/run2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/toolbar-zh.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshots/toolbar.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a90ec96

Please sign in to comment.