From 02e24799ad7dbd7d400a9f15280582791d390814 Mon Sep 17 00:00:00 2001 From: Anton Vakhrushev Date: Sun, 28 Jun 2026 21:29:08 +0300 Subject: [PATCH] =?UTF-8?q?=D0=90=D0=BA=D1=82=D1=83=D0=B0=D0=BB=D0=B8?= =?UTF-8?q?=D0=B7=D0=B8=D1=80=D0=BE=D0=B2=D0=B0=D0=BB=20README?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 36 ++++++++++++++++++++++++++++++------ 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1696736..3ea10fb 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,6 @@ Arr-стек (prowlarr/radarr/sonarr) плохо ложится на русск При высокой уверенности раскладка выполняется автоматически, иначе — уходит на подтверждение человеку. -Доступ к внешним сервисам (LLM, базы метаданных, Telegram) при -необходимости идёт через HTTP-прокси — задаётся полем `proxy` в -соответствующих секциях конфигурации. - ## Статус Рабочий прототип с полным сквозным путём: приём magnet → загрузка в @@ -49,8 +45,21 @@ REST API, веб-UI, Telegram-бот и CLI (`jellybit add`). ## Документация -- [docs/specs/](docs/specs/) — спецификации: целевое устройство системы. - Начать с [architecture.md](docs/specs/architecture.md). +Разработка идёт по **Spec-Driven Development** через +[OpenSpec](https://github.com/Fission-AI/OpenSpec): изменение сначала +описывается спекой, потом реализуется. + +- [openspec/](openspec/) — OpenSpec: актуальные capability-спеки в + `openspec/specs/`, изменения (proposal → design → tasks → archive) в + `openspec/changes/`. Capabilities постепенно переносятся сюда из + `docs/specs/`. +- [docs/conventions/](docs/conventions/) — конвенции кода (*как* пишем): + логирование ([logging.md](docs/conventions/logging.md)), конфигурация + ([config.md](docs/conventions/config.md)), ошибки + ([errors.md](docs/conventions/errors.md)). +- [docs/specs/](docs/specs/) — спецификации устройства системы + (архитектурный обзор + ещё не перенесённые в OpenSpec темы). Начать с + [architecture.md](docs/specs/architecture.md). - [docs/adr/](docs/adr/) — журнал архитектурных решений (почему так). - [docs/drafts/](docs/drafts/) — черновики: планы, идеи, нерешённое. @@ -61,6 +70,21 @@ Go (один статический бинарь), SQLite (`modernc.org/sqlite` TOML, логи — структурированный JSON (`slog`). Подробнее — в [architecture.md](docs/specs/architecture.md). +## Конфигурация + +Конфигурация — один файл TOML. По умолчанию ищется `config.toml` в рабочей +директории; путь переопределяется опцией `--config=path`. Образец со всеми +секциями и описанием каждого поля (назначение, диапазон значений, единицы +измерения) — [config.example.toml](config.example.toml); скопируй его в +`config.toml` и заполни под себя. Конфиг валидируется на старте: при +ошибке сервис не стартует. + +Секреты (пароль qBittorrent, ключи LLM/метабаз, токен Telegram) в репозиторий +не коммитятся — их подставляет деплой прямо в файл. Доступ к внешним сервисам +(LLM, базы метаданных, Telegram) при необходимости идёт через HTTP-прокси — +поле `proxy` в соответствующих секциях. Правила — в +[docs/conventions/config.md](docs/conventions/config.md). + ## Разработка Нужны Go 1.26 и [Task](https://taskfile.dev). Полный список задач —