Skip to content

docs: refresh the READMEs for the current v2 - #66

Merged
compot-dev merged 1 commit into
v2from
docs/readme-refresh
Oct 12, 2026
Merged

compot-dev merged 1 commit into
v2from
docs/readme-refresh

Conversation

@compot-dev

Copy link
Copy Markdown
Collaborator

Brings the three READMEs (EN/RU/ZH) in line with the current v2. Stacked on #64 because it builds on its 8-slot text; the base will be switched to v2 once #64 is merged.

  • Quick start: camera numbers 1–8.
  • Features: automatic decoder recovery, picture fitted to any screen shape, multi-view audio, encrypted URL storage.
  • Gestures: zoom and pan work in single view; in multi-view a long press selects the cell's audio instead of taking a screenshot.
  • Naming: Quad mode becomes multi-view (Quad) where the 2×2/3×3 grid is meant; the menu button is still Q.
  • Known limitations: G.726 and in-band LATM are marked as deliberate (Unsupported audio formats: MP4A-LATM, Opus, G.726, fragmented AAC #14); UDP is listed as "not yet" (RTSP over TCP only: no UDP or multicast transport #7); the intro no longer says every item is planned.
  • Architecture: RtspSession, RtspAuth, Sdp, DecoderRetry, CredentialStore, KeystoreCipher, Frame, App and Crash are added, and the roles of RtspClient, QuadCell and others are updated to the current code.
  • Devices: the Image is cropped at the edges on non-16:9 screens #17 cropping notes now say it is fixed in v2; the AG-216 box is added as the v2 test device.
  • All tables are realigned with spaces (CJK characters count as double width).

Documentation only.

- Quick start: slots 1-8; features: decoder recovery, fitted picture, multi-view audio,
  encrypted URLs; gestures: zoom is single view, long press in multi-view selects audio
- Quad renamed to multi-view (Quad) where it describes the 2x2/3x3 grid
- Known limitations: G.726 / in-band LATM marked as deliberate (#14), UDP 'not yet' (#7)
- Architecture: RtspSession, RtspAuth, Sdp, DecoderRetry, CredentialStore,
  KeystoreCipher, Frame, App, Crash added; roles updated
- Devices: #17 cropping marked as fixed in v2; AG-216 added as the v2 test device
- Tables realigned
@compot-dev
compot-dev changed the base branch from feat/eight-slots to v2 October 12, 2026 18:47
@compot-dev

Copy link
Copy Markdown
Collaborator Author

/review

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can commit Qodo's fix in one click with committable suggestions (GitHub & GitLab)

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@compot-dev
compot-dev merged commit 96ac34e into v2 Oct 12, 2026
4 checks passed
@compot-dev
compot-dev deleted the docs/readme-refresh branch October 13, 2026 17:15
compot-dev added a commit that referenced this pull request Oct 15, 2026
docs: refresh the READMEs for the current v2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant