Skip to content

Commit 2b08407

Browse files
committed
docs: polish README presentation
Signed-off-by: Sertac Ozercan <sozercan@gmail.com>
1 parent f83e521 commit 2b08407

3 files changed

Lines changed: 63 additions & 21 deletions

File tree

‎README.md‎

Lines changed: 63 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,35 @@
1-
# OpenInCode
1+
<p align="center">
2+
<img src="docs/assets/open-in-code-icon.png" width="112" alt="Open in Code app icon">
3+
</p>
24

3-
Open the folder you are viewing in Finder—or the folder containing a selected item—in Visual Studio Code with one toolbar click.
5+
<h1 align="center">Open in Code</h1>
6+
7+
<p align="center">
8+
Open the folder you are viewing in Finder—or the folder containing a selected item—in Visual Studio Code with one click.
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://github.com/sozercan/OpenInCode/releases/latest"><img src="https://img.shields.io/github/v/release/sozercan/OpenInCode?style=flat-square&amp;label=release&amp;color=0A84FF" alt="Latest release"></a>
13+
<img src="https://img.shields.io/badge/macOS-12%2B-1f2937?style=flat-square&amp;logo=apple&amp;logoColor=white" alt="macOS 12 or newer">
14+
<a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-34c759?style=flat-square" alt="MIT license"></a>
15+
</p>
16+
17+
<p align="center">
18+
<a href="#install">Install</a> ·
19+
<a href="#add-it-to-finder">Set up</a> ·
20+
<a href="#how-it-works">How it works</a> ·
21+
<a href="CONTRIBUTING.md">Contribute</a>
22+
</p>
23+
24+
<p align="center">
25+
<img src="docs/assets/open-in-code-hero.png" width="100%" alt="Open in Code takes a selected Finder item and opens its folder in Visual Studio Code">
26+
</p>
27+
28+
Open in Code is a small, native macOS utility built for the Finder toolbar. It gets you from the file you are looking at to the matching VS Code workspace without opening a terminal or navigating to the folder again.
29+
30+
| **One click** | **Finder-aware** | **Stable or Insiders** |
31+
| --- | --- | --- |
32+
| Lives in the Finder toolbar, ready whenever you need it. | Uses your selection when available and the current Finder window when it is not. | Prefers Visual Studio Code and falls back to Visual Studio Code Insiders. |
433

534
## Requirements
635

@@ -9,41 +38,54 @@ Open the folder you are viewing in Finder—or the folder containing a selected
938

1039
## Install
1140

12-
Install the latest release with Homebrew:
41+
### Homebrew
1342

1443
```sh
1544
brew install --cask sozercan/repo/open-in-code
1645
```
1746

18-
You can also download the app from [GitHub Releases](https://github.com/sozercan/OpenInCode/releases). If you download it directly, move **Open in Code.app** to `/Applications`.
47+
### Direct download
1948

20-
## Add Open in Code to Finder
49+
Download the app from [GitHub Releases](https://github.com/sozercan/OpenInCode/releases), then move **Open in Code.app** to `/Applications`.
50+
51+
## Add it to Finder
2152

2253
1. Open `/Applications` in Finder.
23-
2. Hold Command and drag **Open in Code** to the Finder toolbar.
24-
3. Release it where you want the toolbar button to appear.
54+
2. Hold <kbd>⌘ Command</kbd> and drag **Open in Code** to the Finder toolbar.
55+
3. Drop it wherever you want the button to live.
56+
57+
Hold <kbd>⌘ Command</kbd> while dragging the button again to reposition or remove it.
58+
59+
## How it works
2560

26-
To remove or reposition the button later, hold Command while dragging it.
61+
Open a Finder window, optionally select an item, and click **Open in Code**.
2762

28-
## Use
63+
| Finder state | What opens in VS Code |
64+
| --- | --- |
65+
| A folder is selected | The selected folder |
66+
| A file or Finder package is selected | Its containing folder |
67+
| Multiple items are selected | The first selected item's folder |
68+
| Nothing is selected | The folder shown in the front Finder window |
2969

30-
Open a Finder window, optionally select an item, and click **Open in Code** in the toolbar.
70+
## Finder permission
3171

32-
- A selected folder opens directly.
33-
- A selected file or Finder package opens its containing folder.
34-
- If multiple items are selected, the first item is used.
35-
- If nothing is selected, the folder shown in the front Finder window opens.
36-
- Visual Studio Code is preferred; Visual Studio Code Insiders is used when the stable app is not installed.
72+
> [!NOTE]
73+
> On first use, macOS asks whether **Open in Code** may control Finder. Allow access so the app can read the current Finder selection.
3774
38-
## Allow Finder access
75+
<details>
76+
<summary><strong>If Finder access was previously denied</strong></summary>
3977

40-
On first use, macOS asks whether **Open in Code** may control Finder. Allow access so the app can read the current Finder selection.
78+
Enable **Open in Code → Finder** in the appropriate settings pane:
4179

42-
If access was previously denied, enable **Open in Code → Finder** here:
80+
- **macOS 13 or newer:** System Settings → Privacy & Security → Automation
81+
- **macOS 12:** System Preferences → Security & Privacy → Privacy → Automation
4382

44-
- macOS 13 or newer: **System Settings → Privacy & Security → Automation**
45-
- macOS 12: **System Preferences → Security & Privacy → Privacy → Automation**
83+
</details>
4684

4785
## Contributing
4886

49-
See [CONTRIBUTING.md](CONTRIBUTING.md) for source builds, tests, packaging, and release instructions.
87+
Source builds, tests, packaging, and release instructions live in [CONTRIBUTING.md](CONTRIBUTING.md).
88+
89+
---
90+
91+
<p align="center"><sub>Made for macOS · Licensed under the <a href="LICENSE">MIT License</a></sub></p>

‎docs/assets/open-in-code-hero.png‎

153 KB
Loading

‎docs/assets/open-in-code-icon.png‎

50 KB
Loading

0 commit comments

Comments
 (0)