docs: добавлен README с инструкцией по установке и использованию
- Зачем: - чтобы коллега мог установить и запустить проект на Windows/WSL2/Linux без вопросов (шаг 7 plan.md). - Что: - создан README.md: требования, установка через uv tool, примеры CLI, таблицы моделей и квантизаций. - описаны настройка GPU/CUDA по платформам, совместимость GPU, ожидаемая скорость. - добавлен пример выходного файла, соответствующий реальному формату formatter (HH:MM:SS.ss, группировка абзацев). - отмечен шаг 7 как выполненный в plan.md. - Проверка: - uv tool install . && transcribe --help — CLI доступен глобально. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
+9
-13
@@ -275,19 +275,15 @@
|
||||
|
||||
> PRD-ссылки: 4.2 (требования), 4.1.1 (GPU таблица), 4.3 (кроссплатформенность)
|
||||
|
||||
- [ ] Описание: что делает, зачем
|
||||
- [ ] Требования: Python ≥ 3.10, ffmpeg, (опционально) NVIDIA GPU + CUDA
|
||||
- [ ] Установка:
|
||||
```bash
|
||||
git clone <repo>
|
||||
cd local-transcriber
|
||||
uv sync
|
||||
```
|
||||
- [ ] Использование: 3-4 примера команд (простой, с языком, с моделью, CPU)
|
||||
- [ ] Установка ffmpeg: Linux (`apt`), Windows (`winget`/`scoop`), WSL2, macOS (`brew`)
|
||||
- [ ] GPU и CUDA: краткое пояснение, ссылка на NVIDIA docs, что CTranslate2 ставит нужное
|
||||
- [ ] Таблица моделей: имя, размер на диске, VRAM (int8), относительная скорость, качество
|
||||
- [ ] Пример выходного файла (сокращённый)
|
||||
- [x] Описание: что делает, зачем
|
||||
- [x] Требования: Python ≥ 3.10, uv, ffmpeg, (опционально) NVIDIA GPU + драйвер
|
||||
- [x] Установка: `uv tool install .` (CLI глобально в PATH), troubleshooting
|
||||
- [x] Использование: 4 примера команд, таблица опций CLI
|
||||
- [x] Таблица моделей + таблица типов квантизации (`--compute-type`)
|
||||
- [x] Установка ffmpeg: Linux/WSL2 (`apt`), Windows (`winget`), macOS (`brew`)
|
||||
- [x] GPU и CUDA: платформы, режимы `--device`, совместимость GPU, ожидаемая скорость
|
||||
- [x] Пример выходного файла (с корректными HH:MM:SS.ss и группировкой абзацев)
|
||||
- [x] Поддерживаемые форматы аудио/видео
|
||||
|
||||
**Критерий готовности**: коллега может по README установить и запустить на Windows/WSL2 без вопросов.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user