- README.md: new Russian product README (what/features/architecture mermaid/install both feeds/build/repo layout/CI/upstream/docs/license) - README.en.md: concise English mirror (root readme was previously English) - README.ru.md: demoted to a pointer stub (was the sing-box-lx fork readme, a competing Russian README) -> points to README.md + engine-fork docs - docs-shater/README.md: folder index Install commands copied verbatim from docs-shater/INSTALL.md; all links verified against existing files. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1.5 KiB
1.5 KiB
Документация shater
Документация продукта shater (управляемый интернет-шлюз для роутеров на
OpenWrt). Лицо репозитория и быстрый старт — в корневом ../README.md.
| Документ | О чём |
|---|---|
| CONTEXT.md | Начните здесь — контекст проекта, история v0.1→v0.2, решения в кратце, testbed/инфра |
| INSTALL.md | Сборка ship-артефакта (shaterd) и установка обоих фидов — opkg (24.10) и apk (25.12+) |
| ARCHITECTURE.md | One-binary дизайн, auth-handoff LuCI→панель, data/DNS/apply-потоки (диаграммы) |
| FEATURES.md | Полный список фич с тегами MVP/T1/T2 |
| ROADMAP.md | Фазовый план |
| DECISIONS.md | Почему sing-box, почему форк, split панели, лицензия и т.д. |
| DESIGN.md | Визуальная система панели — направление «Faceplate», токены, компоненты |
| PORTING.md | Порт проверенных кусков из v0.1 |
Документация движка-форка (sing-box-lx) — в его слое: ../docs-lx/
и ../SPECS/.