From de86c8c27f1a4b95e2e258f52adfce8d1b20fca6 Mon Sep 17 00:00:00 2001 From: Levon Gevorgyan Date: Fri, 28 Nov 2025 13:36:24 -0600 Subject: [PATCH] update README.md --- README.md | 17 ++++++++++------- lib/readme.sh | 17 ++++++++++------- 2 files changed, 20 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index d28fb37..fc6a909 100644 --- a/README.md +++ b/README.md @@ -52,15 +52,18 @@ Examples: Make sure to install required dependencies using `./scripts/install_deps.sh`. Then build ffmpeg with the desired configuration using `./scripts/build.sh`. ### Docker build -1. choose a given distro from: ubuntu fedora debian archlinux. +1. choose a given distro from: `ubuntu fedora debian archlinux`. 2. build a docker image with the required dependencies pre-installed using `./scripts/docker_build_image.sh` ``. 3. run a docker image with the given arguments using `./scripts/docker_run_image.sh` `` `./scripts/build.sh` -Docker builds support the same configuration options as native builds. For example: -`ENABLE='libdav1d' ./scripts/docker_run_image.sh ubuntu ./scripts/build.sh` to build `ffmpeg` on ubuntu with only `libdav1d` enabled. +Docker builds support the same configuration options as native builds. For example to build `ffmpeg` on ubuntu with only `libdav1d` enabled: +```bash +./scripts/docker_build_image.sh ubuntu +ENABLE='libdav1d' ./scripts/docker_run_image.sh ubuntu ./scripts/build.sh +``` # Encoding scripts -The encoding scripts are designed to be installed to system paths for re-use via symbolic links back to this repo. +The encoding scripts are designed to be installed to system paths for re-use via symbolic links back to this repo using the `-I` flag. ## Encoding with svtav1-psy and opus ```bash @@ -80,9 +83,9 @@ encode -i input [options] output [-I] system install at /usr/local/bin/encode [-U] uninstall from /usr/local/bin/encode ``` -- Uses svtav1-psy for the video encoder -- Uses libopus for the audio encoder -- Skips re-encoding av1/opus content +- Uses svtav1-psy for the video encoder. +- Uses libopus for the audio encoder. +- Skips re-encoding av1/opus streams. - Only maps audio streams that match the video stream language if the video stream has a defined language. - Only maps english subtitle streams. - Adds track statistics to the output mkv file and embeds the encoder versions to the output metadata. For example: diff --git a/lib/readme.sh b/lib/readme.sh index 28fffff..5ea965e 100644 --- a/lib/readme.sh +++ b/lib/readme.sh @@ -58,23 +58,26 @@ Examples: Make sure to $(gen_function_info install_deps). Then $(gen_function_info build). ### Docker build -1. choose a given distro from: ${VALID_DOCKER_IMAGES[*]}. +1. choose a given distro from: \`${VALID_DOCKER_IMAGES[*]}\`. 2. $(gen_function_info docker_build_image) \`\`. 3. $(gen_function_info docker_run_image) \`\` \`./scripts/build.sh\` -Docker builds support the same configuration options as native builds. For example: -\`ENABLE='libdav1d' ./scripts/docker_run_image.sh ubuntu ./scripts/build.sh\` to build \`ffmpeg\` on ubuntu with only \`libdav1d\` enabled. +Docker builds support the same configuration options as native builds. For example to build \`ffmpeg\` on ubuntu with only \`libdav1d\` enabled: +\`\`\`bash +./scripts/docker_build_image.sh ubuntu +ENABLE='libdav1d' ./scripts/docker_run_image.sh ubuntu ./scripts/build.sh +\`\`\` # Encoding scripts -The encoding scripts are designed to be installed to system paths for re-use via symbolic links back to this repo. +The encoding scripts are designed to be installed to system paths for re-use via symbolic links back to this repo using the \`-I\` flag. ## Encoding with svtav1-psy and opus \`\`\`bash $(encode) \`\`\` -- Uses svtav1-psy for the video encoder -- Uses libopus for the audio encoder -- Skips re-encoding av1/opus content +- Uses svtav1-psy for the video encoder. +- Uses libopus for the audio encoder. +- Skips re-encoding av1/opus streams. - Only maps audio streams that match the video stream language if the video stream has a defined language. - Only maps english subtitle streams. - Adds track statistics to the output mkv file and embeds the encoder versions to the output metadata. For example: