Добавлены страницы вики для GenAudioBookInfo: Home, Installation, Makefile, OpenRouter, Output Structure, TorrAPI и Sidebar.
Создана структура документации, описывающая функциональность, установку, использование CLI, архитектуру и интеграции с TorrAPI и OpenRouter. Добавлены примеры конфигурации и метаданных, а также описание структуры выходных данных.
This commit is contained in:
@@ -0,0 +1,89 @@
|
||||
# Установка и сборка
|
||||
|
||||
## Требования
|
||||
|
||||
| Компонент | Версия | Обязательно |
|
||||
|---|---|---|
|
||||
| Go | 1.22+ | ✅ |
|
||||
| TorrAPI-совместимый сервер | любая | ✅ |
|
||||
| OpenRouter API ключ | — | ❌ (только для LLM) |
|
||||
|
||||
## Сборка из исходников
|
||||
|
||||
```bash
|
||||
# Клонировать репозиторий
|
||||
git clone https://github.dfv24.com/fofanov/genaudiobookinfo.git
|
||||
cd genaudiobookinfo
|
||||
|
||||
# Загрузить зависимости
|
||||
go mod tidy
|
||||
|
||||
# Сборка
|
||||
go build -o genaudiobookinfo ./cmd/genaudiobookinfo
|
||||
|
||||
# Или через Makefile
|
||||
make build
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
```powershell
|
||||
go build -o genaudiobookinfo.exe ./cmd/genaudiobookinfo
|
||||
```
|
||||
|
||||
## Зависимости
|
||||
|
||||
Все зависимости управляются через Go Modules. Основные:
|
||||
|
||||
| Модуль | Назначение |
|
||||
|---|---|
|
||||
| `charmbracelet/bubbletea` | TUI-фреймворк (интерактивный вывод) |
|
||||
| `charmbracelet/lipgloss` | Цветовое оформление терминала (Dracula scheme) |
|
||||
| `charmbracelet/bubbles` | Компоненты TUI: прогресс, спиннер |
|
||||
| `dhowden/tag` | Чтение ID3/Vorbis/MP4 тегов из аудиофайлов |
|
||||
| `tcolgate/mp3` | Расчёт длительности MP3 с VBR |
|
||||
| `schollz/progressbar/v3` | Прогресс-бар для ConsoleLogger |
|
||||
| `gopkg.in/yaml.v3` | ~~Парсинг `config.yaml`~~ удалён |
|
||||
|
||||
## Первичная настройка
|
||||
|
||||
1. Скопировать шаблон конфигурации:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
2. Изменить пути в `.env`:
|
||||
|
||||
```env
|
||||
DIR_IN=/path/to/audiobooks # входная папка
|
||||
DIR_OUT=/path/to/result # папка результатов (опционально)
|
||||
```
|
||||
|
||||
3. Настроить TorrAPI:
|
||||
|
||||
```env
|
||||
TORRAPI_URL=http://localhost:9200 # адрес TorrServer
|
||||
```
|
||||
|
||||
4. Запустить:
|
||||
|
||||
```bash
|
||||
./genaudiobookinfo
|
||||
```
|
||||
|
||||
## Проверка сборки
|
||||
|
||||
```bash
|
||||
go vet ./...
|
||||
go test ./...
|
||||
./genaudiobookinfo -version
|
||||
```
|
||||
|
||||
## Обновление
|
||||
|
||||
```bash
|
||||
git pull
|
||||
go mod tidy
|
||||
make build
|
||||
```
|
||||
Reference in New Issue
Block a user