Skip to content

Commit 0079e82

Browse files
committed
Alinha README com o conteúdo do site (Pages)
Adiciona screenshots, tabela comparativa, seção de instalação com nota do Google Play em closed testing e link de apoio no Ko-fi — tudo já existia no site, faltava no README.
1 parent 077db81 commit 0079e82

1 file changed

Lines changed: 37 additions & 1 deletion

File tree

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ over WiFi or USB, with touch and scroll input — speaking the same network prot
99
official app, with no changes required on the Mac side.
1010

1111
[Website & download](https://opendisplay.jpmo.dev.br) ·
12-
[How it works](#how-it-works) · [Build](#build) · [Usage](#usage) ·
12+
[How it works](#how-it-works) · [Screenshots](#screenshots) · [Features](#features) ·
13+
[Compare](#compare) · [Install](#install) · [Build](#build) · [Usage](#usage) ·
1314
[License](#license)
1415

1516
The original OpenDisplay project only ships an iOS/iPadOS client. This repository is the Android
@@ -30,6 +31,13 @@ CGVirtualDisplay
3031
The Android device listens and the Mac connects — that's what lets it work over WiFi with zero
3132
manual setup, via mDNS/Bonjour discovery (`_opensidecar._tcp`).
3233

34+
## Screenshots
35+
36+
<img src="docs/screenshots/tablet-mirroring-site.jpeg" alt="Android tablet on a desk, mirroring this project's website from the Mac over WiFi" width="420"> <img src="docs/screenshots/app-home.jpeg" alt="OpenDisplay Android app home screen, listening on port 9000 and waiting for the Mac to connect" width="420">
37+
38+
No staged mockups — real hardware, real WiFi connection. More shots (settings, mid-session
39+
mirroring, the Mac's Displays panel) on the [website](https://opendisplay.jpmo.dev.br/#screenshots).
40+
3341
## Features
3442

3543
- H.264 video reception via `MediaCodec` (hardware decoding), straight to a `Surface`.
@@ -44,6 +52,18 @@ manual setup, via mDNS/Bonjour discovery (`_opensidecar._tcp`).
4452
- Optional performance HUD (fps, end-to-end latency, RTT).
4553
- Adaptive UI (Jetpack Compose) for phone and tablet.
4654

55+
## Compare
56+
57+
For using an Android tablet as an external monitor, against the best-known alternatives:
58+
59+
| | OpenDisplay Android | Duet Display | Spacedesk |
60+
|---|---|---|---|
61+
| Price | Free | Paid | Free (core) |
62+
| Open source | GPL-3.0 | No | No |
63+
| Account required | No | Yes | No |
64+
| Same protocol as OpenDisplay Mac | Yes | No | No |
65+
| Central server | None | Yes | No |
66+
4767
## Requirements
4868

4969
- Android 8.0 (API 26) or higher. **v0.0.7 and earlier crash on launch on Android 12–13
@@ -52,6 +72,16 @@ manual setup, via mDNS/Bonjour discovery (`_opensidecar._tcp`).
5272
[@edoardomich](https://github.com/edoardomich) in [#5](https://github.com/josepacelli/opendisplay-android/pull/5)).
5373
- Same WiFi network as the Mac (or a USB connection via `adb forward` — see below).
5474
- The original [OpenDisplay](https://github.com/peetzweg/opendisplay) Mac app, unmodified.
75+
- Tested on real hardware (Samsung Galaxy Tab S9 FE+ and Galaxy Note10+/Tab S7+, Android 12
76+
through 16) — not yet across a wide range of devices.
77+
78+
## Install
79+
80+
Download the latest APK from [GitHub Releases](https://github.com/josepacelli/opendisplay-android/releases/latest)
81+
and sideload it (`adb install`, or copy it to the device and enable "unknown sources").
82+
83+
The Google Play version is in closed testing — want in as a tester? Email
84+
[josepacelli@gmail.com](mailto:josepacelli@gmail.com).
5585

5686
## Build
5787

@@ -109,6 +139,12 @@ original project's author.
109139
immersive fullscreen mode
110140
([#45](https://github.com/josepacelli/opendisplay-android/issues/45)).
111141

142+
## Support
143+
144+
One-person side project, built evenings and weekends, not a company. If it saved you from buying
145+
a monitor, [a tip on Ko-fi](https://ko-fi.com/Q3D5259MWT) helps keep it maintained and free for
146+
everyone.
147+
112148
## License
113149

114150
GPL-3.0, the same license as the original project. See [`LICENSE`](LICENSE) and

0 commit comments

Comments
 (0)