Актуализировал README
This commit is contained in:
@@ -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). Полный список задач —
|
||||
|
||||
Reference in New Issue
Block a user