44r0n7/vid-repair
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add friendly icons to README

Browse Source
This commit is contained in:
44r0n7
2025-12-31 23:00:15 -05:00
parent 1349d632b2
commit 98a632a399
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -1,20 +1,20 @@
# Vid-Repair # Vid-Repair 🎬🛠️
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`. 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 ## Quick Start 🚀
### Requirements ### Requirements ✅
- `ffmpeg` and `ffprobe` available on PATH - `ffmpeg` and `ffprobe` available on PATH
### Install ### Install 🧰
```bash ```bash
cargo build --release cargo build --release
``` ```
### Common commands ### Common commands 💻
```bash ```bash
# Scan files or folders # Scan files or folders
@@ -33,7 +33,7 @@ vid-repair fix --policy aggressive /path/to/videos
vid-repair scan --json /path/to/videos vid-repair scan --json /path/to/videos
``` ```
### Scan depth ### Scan depth 🔎
```bash ```bash
# Quick scan (faster, less thorough) # Quick scan (faster, less thorough)
@@ -46,21 +46,21 @@ vid-repair scan --scan-depth standard /path/to/videos
vid-repair scan --scan-depth deep /path/to/videos vid-repair scan --scan-depth deep /path/to/videos
``` ```
### Recursive vs non‑recursive ### Recursive vs non‑recursive 🧭
```bash ```bash
# Disable recursive scanning # Disable recursive scanning
vid-repair scan --no-recursive /path/to/videos vid-repair scan --no-recursive /path/to/videos
``` ```
### Exit codes ### Exit codes 🧾
- `0` no issues - `0` no issues
- `1` issues found - `1` issues found
- `2` fix failed - `2` fix failed
- `3` fatal error - `3` fatal error
## Config ## Config ⚙️
On first run, a commented TOML config is created in the XDG config directory: On first run, a commented TOML config is created in the XDG config directory:
@@ -70,18 +70,18 @@ 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. You can edit this file to set defaults like scan depth, include/exclude patterns, and watch behavior. CLI flags always override config values.
# Developer Guide # Developer Guide 🛠️
This section is for contributors and anyone building on the project. This section is for contributors and anyone building on the project.
## Project layout ## Project layout 🧱
- `vid-repair/` – CLI binary - `vid-repair/` – CLI binary
- `vid-repair-core/` – core library (scan, rules, fix, report, watch) - `vid-repair-core/` – core library (scan, rules, fix, report, watch)
- `rulesets/` – modular rule packs (TOML) - `rulesets/` – modular rule packs (TOML)
- `scripts/` – helper scripts (fixtures, checks) - `scripts/` – helper scripts (fixtures, checks)
## Rulesets ## Rulesets 🧩
Rules are data‑driven and split by domain in `rulesets/*.toml`. Rules are data‑driven and split by domain in `rulesets/*.toml`.
Before shipping changes: Before shipping changes:
@@ -90,7 +90,7 @@ Before shipping changes:
vid-repair rules lint vid-repair rules lint
``` ```
## Fixtures ## Fixtures 🧪
Generate fixtures locally (git‑ignored): Generate fixtures locally (git‑ignored):
@@ -100,7 +100,7 @@ scripts/generate_fixtures.sh
Use fixtures to validate scan logic and rule coverage. Add new fixtures for real‑world edge cases (truncated files, corrupted NAL units, etc.). Use fixtures to validate scan logic and rule coverage. Add new fixtures for real‑world edge cases (truncated files, corrupted NAL units, etc.).
## Tests ## Tests ✅
```bash ```bash
scripts/check.sh scripts/check.sh