Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 5.11 KB

README.md

File metadata and controls

37 lines (30 loc) · 5.11 KB

AudioModem documentation

English (canonical) · Русский

This directory holds the human-readable technical documentation for AudioModem. English files are canonical. Russian translations use the _RU.md suffix, link to their English source, and are informative unless an RFC explicitly says otherwise.

Section English Russian Scope
Guides Quick start Быстрый старт Verified bootstrap and controlled Acoustic-1 WAV workflows
Guides Audio routes Аудиомаршруты Delivery routes and scope boundaries
Reference Platform support Поддержка платформ Runners versus supported features
Reference Transmission presets Пресеты передачи Profile identifiers and intent
Operations Troubleshooting Диагностика Reproducible observations and reports
Operations Device acceptance Приёмка устройств Evidence contract and decision gates for future live routes
Project Roadmap Дорожная карта Verified work and upcoming milestones
Project Implementation plan План реализации Test-gated order from core contracts through Flutter shell and route evidence
Architecture Flutter ↔ Rust WAV bridge Flutter ↔ Rust WAV bridge на русском Native facade and in-memory WAV verification boundary
Architecture Android foreground live audio Android foreground live audio на русском Experimental source adapter and evidence boundary
Research Flutter Rust Bridge integration Flutter Rust Bridge integration на русском Generated-code layout and regeneration command
Research Acoustic-1 PHY sources Источники Acoustic-1 PHY Design sources and explicit receiver/FEC constraints
Research Acoustic-2 measurement sources Источники измерений Acoustic-2 Controlled PCM transform and timing-acquisition constraints
Research Device-acceptance sources Источники device acceptance Reproducible evidence, metadata and privacy constraints
Research Live-audio adapter sources Источники live-audio adapter Session, permission, focus and lifecycle constraints
Research Android live-audio adapter sources Источники Android live-audio adapter First-target decision and Android/PipeWire route constraints
Specification ADLP v1 ADLP v1 на русском Normative wire object and WAV bootstrap carrier
Specification Acoustic-1 Acoustic-1 на русском Experimental B-FSK carrier and compatibility boundary
Specification Acoustic-2 Acoustic-2 на русском Experimental controlled PCM measurement contract
Specification Live-audio adapter v1 Live-audio adapter v1 на русском Typed unavailable-first contract for future routes
Specification Android live-audio adapter v1 Android live-audio adapter v1 на русском Draft foreground Android route lifecycle and acceptance constraints

Translation convention

An English source document begins with Last reviewed. Its Russian sibling records both Translation of and Last synced. A translation should be updated in the same pull request when an English source changes materially; otherwise, open a translation-only pull request and identify the source revision.

Documentation contribution

Documentation corrections are welcome. Please keep examples executable, label planned capabilities clearly, and do not describe a platform or route as supported until its release criteria are met. See CONTRIBUTING.md for the repository workflow.