Add friendly icons to README
This commit is contained in:
28
README.md
28
README.md
@@ -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`.
|
||||
|
||||
## Quick Start
|
||||
## Quick Start 🚀
|
||||
|
||||
### Requirements
|
||||
### Requirements ✅
|
||||
|
||||
- `ffmpeg` and `ffprobe` available on PATH
|
||||
|
||||
### Install
|
||||
### Install 🧰
|
||||
|
||||
```bash
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
### Common commands
|
||||
### Common commands 💻
|
||||
|
||||
```bash
|
||||
# Scan files or folders
|
||||
@@ -33,7 +33,7 @@ vid-repair fix --policy aggressive /path/to/videos
|
||||
vid-repair scan --json /path/to/videos
|
||||
```
|
||||
|
||||
### Scan depth
|
||||
### Scan depth 🔎
|
||||
|
||||
```bash
|
||||
# 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
|
||||
```
|
||||
|
||||
### Recursive vs non‑recursive
|
||||
### Recursive vs non‑recursive 🧭
|
||||
|
||||
```bash
|
||||
# Disable recursive scanning
|
||||
vid-repair scan --no-recursive /path/to/videos
|
||||
```
|
||||
|
||||
### Exit codes
|
||||
### Exit codes 🧾
|
||||
|
||||
- `0` no issues
|
||||
- `1` issues found
|
||||
- `2` fix failed
|
||||
- `3` fatal error
|
||||
|
||||
## Config
|
||||
## Config ⚙️
|
||||
|
||||
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.
|
||||
|
||||
# Developer Guide
|
||||
# Developer Guide 🛠️
|
||||
|
||||
This section is for contributors and anyone building on the project.
|
||||
|
||||
## Project layout
|
||||
## Project layout 🧱
|
||||
|
||||
- `vid-repair/` – CLI binary
|
||||
- `vid-repair-core/` – core library (scan, rules, fix, report, watch)
|
||||
- `rulesets/` – modular rule packs (TOML)
|
||||
- `scripts/` – helper scripts (fixtures, checks)
|
||||
|
||||
## Rulesets
|
||||
## Rulesets 🧩
|
||||
|
||||
Rules are data‑driven and split by domain in `rulesets/*.toml`.
|
||||
Before shipping changes:
|
||||
@@ -90,7 +90,7 @@ Before shipping changes:
|
||||
vid-repair rules lint
|
||||
```
|
||||
|
||||
## Fixtures
|
||||
## Fixtures 🧪
|
||||
|
||||
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.).
|
||||
|
||||
## Tests
|
||||
## Tests ✅
|
||||
|
||||
```bash
|
||||
scripts/check.sh
|
||||
|
||||
Reference in New Issue
Block a user