Repository navigation
docs: move the details out of the README into docs/, like OpenIPC/vtesse #191
Description
The README is 318 lines in three languages (EN/RU/ZH), and it mixes the quick start with the menu, every transport, the debug page, architecture, security, devices and version history. Every detail change means three edits in sync, and a new user has to scroll past the internals.
OpenIPC/vtesse keeps a short README (features, download, quick start per platform, roadmap) that ends with a Documentation table pointing into docs/. Each document there is English only and starts with its own table of contents, and the documents use tables and ASCII diagrams.
Proposal
The README (EN/RU/ZH) keeps the logo and badges, a short what it is, the screenshots, Download, Requirements, Quick start, a short Controls summary, Known limitations, Support and License. It ends with a Documentation table. The ~120 lines left in each language are what gets translated.
New docs/ (English, like vtesse):
| file | from the README today, plus |
|---|---|
docs/usage.md |
menu and grid menu, gestures and keys, remote control, opening a camera from another app (share intent), multi-view (Q/S/U), Reset, slides |
docs/transports.md |
URL formats and options per transport: RTSP over TCP/UDP/auto, multicast, plain RTP/UDP push (Majestic outgoing), RTSP and HTTP MJPEG, later FLOW-UFO (#187); what each server supports (from LABORATORY.md) |
docs/debug.md |
debug page on 8085, a field reference for /stats.json, /log, snapshots, what to send with a bug report |
docs/architecture.md |
an ASCII diagram (network → RTSP/RTP/HTTP → assemblers → MediaCodec/JPEG → SurfaceView); classes and threads; the decode planner (#85, #189); why the views are SurfaceViews (#61, #76) |
docs/testing.md |
CI, unit tests, versions and releases (2.xx, versioned releases, mapping.txt), how to test a branch build; the lab bench stays in LABORATORY.md and is linked |
docs/security.md |
credential store, the debug server answers the LAN only, redaction in logs, no TLS for RTSP |
docs/devices.md |
verified and not working devices, hardware decoder notes |
docs/img/ |
pictures for the documents (README screenshots stay in screenshots/) |
Version history goes to the release notes (CI already writes them per v2.xx) and a short CHANGELOG link.
Open questions
- docs/ in English only (as in vtesse), or also RU/ZH?
- Keep LABORATORY.md as it is (the bench) or move it to
docs/laboratory.md?
Plan: one docs-only PR, with no app change and no version bump.
Activity
compot-dev commentedon Oct 15, 2026
Decisions:
docs/in English only.docs/toys.md: drones and Wi‑Fi toys. It covers how such toys usually stream (their own access point, fixed addresses, vendor protocols), FLOW-UFO (new feature: receiving udp video strem from cheap toys with wifi cam's #187, test build and status), what to try with an unknown toy, and what to send in a report.Working on it: one docs-only PR.
Merge pull request #192 from OpenIPC/docs/split-191
docs: README trimmed, details in docs/ (#191)
Merge pull request #192 from OpenIPC/docs/split-191