From f5858ba5ab7ea24f42dd3c79e02f0d10dae7d8c6 Mon Sep 17 00:00:00 2001
From: pat-e <pat-e@pat-e.net>
Date: Sat, 2 Aug 2025 13:12:20 +0200
Subject: [PATCH] Updated "readme"

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 51 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 3cce481..8af6d1b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,52 @@
-# SVT-AV1-Essential-helper
+# Anime Audio Helper
 
-A helper for the SVT-AV1-Essential - project
\ No newline at end of file
+A batch-processing tool for MKV files, designed for high-quality AV1 video encoding and efficient audio handling. This script is tailored for anime and similar content, with a focus on automation, quality, and flexibility.
+
+## Features
+
+- **Batch processing** of MKV files in the current directory
+- **Automatic VFR to CFR** conversion using HandBrakeCLI (if needed)
+- **UTVideo intermediate** for lossless video processing
+- **AV1 encoding** via ffmpeg piped to SvtAv1EncApp2 (SVT-AV1-Essential fork)
+- **Audio extraction, normalization, and Opus encoding** (with optional downmixing)
+- **Remuxing of supported audio codecs** (AAC, Opus) without conversion
+- **Optional autocrop detection** using ffmpeg cropdetect
+- **Per-file logging** and organized output directories
+- **Automatic cleanup** of temporary files
+
+## Requirements
+
+- Python 3.7+
+- The following tools must be in your PATH:
+  - `ffmpeg`, `ffprobe`
+  - `mkvmerge`, `mkvpropedit`
+  - `sox`, `opusenc`
+  - `mediainfo`, `HandBrakeCLI`
+  - `SvtAv1EncApp2` (SVT-AV1-Essential fork, must be named exactly as such)
+
+## Usage
+
+```sh
+python anime_audio_helper.py [--no-downmix] [--autocrop]
+```
+
+- `--no-downmix` : Preserve original audio channel layout (do not force stereo)
+- `--autocrop`   : Automatically detect and crop black bars from video
+
+Place your `.mkv` files in the script directory. Processed files will be moved to `completed/`, and originals to `original/`. Logs are saved in `conv_logs/`.
+
+## Configuration
+
+- **Audio remuxing**: Edit the `REMUX_CODECS` set at the top of the script to control which codecs are remuxed instead of converted.
+- **SVT-AV1 parameters**: Edit the `SVT_AV1_PARAMS` dictionary at the top of the script to adjust encoding quality, speed, and other options.
+
+## Notes
+
+- The script expects the SVT-AV1-Essential fork binary to be named `SvtAv1EncApp2`.
+- All video encoding is 10-bit for maximum quality.
+- Scene change detection, auto-tiling, and other advanced options are enabled by default.
+- The script is designed for automation and minimal manual intervention.
+
+## License
+
+See `LICENSE` for details.
\ No newline at end of file