Move rulesets/fixtures info to developer guide

This commit is contained in:
2025-12-31 22:57:51 -05:00
parent 70258ddcbd
commit 1349d632b2

View File

@@ -2,7 +2,7 @@
Vid-Repair is a crossplatform CLI that scans video files for container/stream/decode problems and applies safe repairs using your system `ffmpeg`/`ffprobe`.
## Quick Start (Regular Users)
## Quick Start
### Requirements
@@ -60,7 +60,7 @@ vid-repair scan --no-recursive /path/to/videos
- `2` fix failed
- `3` fatal error
## Config (Regular Users)
## Config
On first run, a commented TOML config is created in the XDG config directory:
@@ -70,30 +70,6 @@ On first run, a commented TOML config is created in the XDG config directory:
You can edit this file to set defaults like scan depth, include/exclude patterns, and watch behavior. CLI flags always override config values.
## Rulesets (Regular Users)
Rulesets tell VidRepair how to interpret ffmpeg error messages. Theyre shipped with the app and already work out of the box.
You generally **do not need to edit them** unless you want to add your own rules or tune behavior.
If you do edit rulesets, run the linter:
```bash
vid-repair rules lint
```
## Fixtures (Regular Users)
Fixtures are small, generated test videos used to validate the scanner.
**You only need this if you are developing or testing changes.**
If you want to generate them manually:
```bash
scripts/generate_fixtures.sh
```
---
# Developer Guide
This section is for contributors and anyone building on the project.
@@ -105,7 +81,7 @@ This section is for contributors and anyone building on the project.
- `rulesets/` modular rule packs (TOML)
- `scripts/` helper scripts (fixtures, checks)
## Rulesets (Dev)
## Rulesets
Rules are datadriven and split by domain in `rulesets/*.toml`.
Before shipping changes:
@@ -114,7 +90,7 @@ Before shipping changes:
vid-repair rules lint
```
## Fixtures (Dev)
## Fixtures
Generate fixtures locally (gitignored):