Skip to content

Commit

Permalink
docs(README): update
Browse files Browse the repository at this point in the history
  • Loading branch information
Ji4n1ng committed Apr 12, 2019
1 parent a90ec96 commit 8860d88
Showing 1 changed file with 11 additions and 9 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# OpenInTerminal

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

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

## How to use
## How to use 🚀

### 1) Open Current Directory from Toolbar

Expand All @@ -18,7 +18,7 @@ Finder Toolbar app for macOS to open the current directory in `Terminal` or `iTe

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

## How to Install
## How to Install 🖥

1. Download from [release](https://github.com/Ji4n1ng/OpenInTerminal/releases).
2. Move the app into `/Applications`.
Expand All @@ -31,11 +31,13 @@ If neither Finder window is opened nor the folder is selected, this app will ope

### 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.
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 cover the default icon.

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

## How to build
## How to build 🔨

`Mojave build passing ✅`

```
git clone https://github.com/Ji4n1ng/OpenInTerminal
Expand All @@ -45,13 +47,13 @@ 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
## 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.
3. 🐞 Fix: If path include `\`, the app will crash when openning in iTerm.

## Special Thanks to
## Special Thanks to ❤️

- [jbtule/cdto](https://github.com/jbtule/cdto)
- [es-kumagai/OpenTerminal](https://github.com/es-kumagai/OpenTerminal)
Expand Down

0 comments on commit 8860d88

Please sign in to comment.