From 1349d632b2adb0304f6bfdde5f432e86244aad1d Mon Sep 17 00:00:00 2001 From: 44r0n7 <44r0n7+gitea@pm.me> Date: Wed, 31 Dec 2025 22:57:51 -0500 Subject: [PATCH] Move rulesets/fixtures info to developer guide --- README.md | 32 ++++---------------------------- 1 file changed, 4 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 61de3af..3c9cfd2 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Vid-Repair is a cross‑platform 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 Vid‑Repair how to interpret ffmpeg error messages. They’re 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 data‑driven 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 (git‑ignored):