Skip to content

Commit f2fc795

Browse files
authored
Updated readme (#17)
1 parent 6b64368 commit f2fc795

1 file changed

Lines changed: 28 additions & 26 deletions

File tree

README.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66

77
[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
88

9-
Snap-O is a tidy and speedy macOS app that captures screenshots and screen recordings from Android devices and emulators.
9+
Snap-O is a fast, tidy macOS app for capturing screenshots and screen recordings from Android devices and emulators.
1010

11-
It runs on macOS 15 or later and needs `adb` from the Android Platform Tools.
11+
It runs on macOS 15 or later and requires `adb` from the Android Platform Tools.
1212

1313
## Why build a screen capture tool?
1414

15-
When you capture screens for teammatesor to drop into pull requests—lots of small paper
16-
cuts add up quickly. You might like Snap-O if you've ever wished you could:
15+
Taking screenshots for teammates or pull requests adds many small paper cuts.
16+
You might like Snap-O if you've ever wished you could:
1717

1818
- Share screenshots and recordings without littering your disk with throwaway files
1919
- Preview a recording instantly without saving it first
@@ -26,7 +26,7 @@ I'm open-sourcing.
2626
## Features
2727

2828
- Shows a screenshot the moment the window opens
29-
- Records Android device screens with one command
29+
- Records Android device screens with a single command
3030
- Keeps your disk uncluttered by cleaning up after itself
3131
- Lets you drag and drop captures anywhere without saving them first
3232
- Supports multiple windows of captures at once
@@ -39,28 +39,30 @@ I'm open-sourcing.
3939
3. Enjoy the immediate screenshot
4040
4. `⌘R` to refresh the screenshot. `⇧⌘R` to start a screen recording.
4141

42-
### ADB Selection
42+
### ADB Selection (optional)
4343

44-
The first time you run Snap-O you will need to tell it where `adb` lives. Snap‑O does not ship with the Android Platform Tools and it will prompt you to choose your installed `adb` binary.
44+
Snap-O talks to the ADB server directly without running `adb`.
4545

46-
Note: Snap‑O uses the macOS Hardened Runtime. It executes the `adb` binary you select; always choose a trusted `adb` from the official Android Platform Tools.
46+
If the ADB server is not running, Snap-O asks you to pick your `adb` binary so it can restart the server for you.
47+
48+
Note: Snap‑O uses the macOS Hardened Runtime. It will run the `adb` binary you select, so always choose a trusted `adb` from the official Android Platform Tools.
4749

4850
### Drag and Drop
4951

50-
After capturing a screenshot or screen recording, drag and drop works without saving the file first. Drop the capture straight into a GitHub pull request, Slack message, or any app that accepts images and video.
52+
After you capture a screenshot or screen recording, you can drag and drop it without saving first. Drop the capture straight into a GitHub pull request, a Slack message, or any app that accepts images and video.
5153

5254
### Keyboard Shortcuts
5355

54-
| Action | Shortcut |
55-
|-------------------------|----------|
56-
| New screenshot | `⌘R` |
57-
| Start recording | `⇧⌘R` |
58-
| Start live preview | `⇧⌘L` |
59-
| Stop recording/ preview | `` |
60-
| Save as | `⌘S` |
61-
| Copy image to clipboard | `⌘C` |
62-
| Previous device | `⌘▲` |
63-
| Next device | `⌘▼` |
56+
| Action | Shortcut |
57+
|--------------------------|----------|
58+
| New screenshot | `⌘R` |
59+
| Start recording | `⇧⌘R` |
60+
| Start live preview | `⇧⌘L` |
61+
| Stop recording / preview | `` |
62+
| Save as | `⌘S` |
63+
| Copy image to clipboard | `⌘C` |
64+
| Previous device | `⌘▲` |
65+
| Next device | `⌘▼` |
6466

6567
### Android Studio External Tools
6668

@@ -76,21 +78,21 @@ Use Android Studio’s External Tools to trigger Snap-O directly from the IDE.
7678

7779
Running these tools launches Snap-O (or brings it to the foreground) and immediately starts a capture or recording.
7880

81+
There is currently no support for choosing a specific device/emulator when starting Snap-O in this way.
82+
7983
## Why not Compose Multiplatform?
8084

81-
Snap-O relies on AVKit because it is the most polished video player to embed on macOS and it keeps the download size small. VLC-based playback felt clunky and the viewing experience suffered. When Compose Multiplatform gains a path to the native player with the same quality, this robot will happily reconsider the architecture.
85+
Snap-O uses AVKit because it gives a polished video player on macOS and keeps the download small. VLC-based playback felt clunky and the viewing experience suffered. When Compose Multiplatform lets us use a native player with the same quality, we'll revisit the design.
8286

8387
## Alternatives
8488

85-
Snap-O doesn't support interactions in its Live Preview mode, yet.
89+
Snap-O currently has only basic "Live Preview" support.
8690

87-
For a more fully-featured live preview, take a look at [scrcpy](https://github.com/Genymobile/scrcpy).
91+
For a more feature-rich live preview, take a look at [scrcpy](https://github.com/Genymobile/scrcpy).
8892

8993
## Project status
9094

91-
Snap-O is a small side project maintained when time and curiosity allow. If it
92-
works for you: fantastic! If it doesn't, please feel free to open an issue or
93-
fork it to taste.
95+
Snap-O is a small side project kept alive when time allows. If it works for you, great! If it doesn't, feel free to open an issue or fork it to fit your needs.
9496

9597
## Building from source
9698

@@ -106,7 +108,7 @@ If you need to notarize the app yourself:
106108

107109
1. Copy `Config/Signing.xcconfig.sample``Config/Signing.xcconfig`.
108110
2. Edit the new file with your Apple Developer Team ID and signing certificate name.
109-
3. Archive (⌘B) or upload as usual. The file is ignored by Git so your credentials remain private.
111+
3. Archive (⌘B) or upload as usual. The file is ignored by Git, so your credentials remain private.
110112

111113
## Community
112114

0 commit comments

Comments
 (0)