jlw_4049/FrameForge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 9 Wiki Activity

refactor: update readme

Browse Source
This commit is contained in:
jlw4049 2024-06-12 01:03:40 -04:00
parent eee1442bc3
commit 19ba7a3ad3
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -5,15 +5,13 @@ A CLI to generate comparison image sets with
## Usage ## Usage
``` ```
usage: FrameForge [-h] [-v] [--source SOURCE] [--encode ENCODE] [--frames FRAMES] usage: FrameForge [-h] [-v] [--source SOURCE] [--encode ENCODE] [--frames FRAMES] [--image-dir IMAGE_DIR]
[--image-dir IMAGE_DIR] [--indexer {lsmash,ffms2}] [--indexer {lsmash,ffms2}] [--source-index-path SOURCE_INDEX_PATH]
[--source-index-path SOURCE_INDEX_PATH] [--encode-index-path ENCODE_INDEX_PATH] [--sub-size SUB_SIZE] [--sub-alignment SUB_ALIGNMENT]
[--encode-index-path ENCODE_INDEX_PATH] [--sub-size SUB_SIZE] [--left-crop LEFT_CROP] [--right-crop RIGHT_CROP] [--top-crop TOP_CROP] [--bottom-crop BOTTOM_CROP]
[--left-crop LEFT_CROP] [--right-crop RIGHT_CROP] [--top-crop TOP_CROP] [--adv-resize-left ADV_RESIZE_LEFT] [--adv-resize-right ADV_RESIZE_RIGHT]
[--bottom-crop BOTTOM_CROP] [--adv-resize-left ADV_RESIZE_LEFT] [--adv-resize-top ADV_RESIZE_TOP] [--adv-resize-bottom ADV_RESIZE_BOTTOM] [--tone-map]
[--adv-resize-right ADV_RESIZE_RIGHT] [--adv-resize-top ADV_RESIZE_TOP] [--re-sync RE_SYNC] [--comparison-count COMPARISON_COUNT] [--subtitle-color SUBTITLE_COLOR]
[--adv-resize-bottom ADV_RESIZE_BOTTOM] [--tone-map] [--re-sync RE_SYNC]
[--comparison-count COMPARISON_COUNT] [--subtitle-color SUBTITLE_COLOR]
[--release-sub-title RELEASE_SUB_TITLE] [--release-sub-title RELEASE_SUB_TITLE]
options: options:
@ -21,8 +19,7 @@ options:
-v, --version show program's version number and exit -v, --version show program's version number and exit
--source SOURCE Path to source file --source SOURCE Path to source file
--encode ENCODE Path to encode file --encode ENCODE Path to encode file
--frames FRAMES Only use this if you want to specify the frames to generate, this --frames FRAMES Only use this if you want to specify the frames to generate, this disables sync frames
disables sync frames
--image-dir IMAGE_DIR --image-dir IMAGE_DIR
Path to base image folder Path to base image folder
--indexer {lsmash,ffms2} --indexer {lsmash,ffms2}
@ -32,6 +29,8 @@ options:
--encode-index-path ENCODE_INDEX_PATH --encode-index-path ENCODE_INDEX_PATH
Path to look/create indexes for encode Path to look/create indexes for encode
--sub-size SUB_SIZE Size of subtitles --sub-size SUB_SIZE Size of subtitles
--sub-alignment SUB_ALIGNMENT
Alignment of subtitles (.ass)
--left-crop LEFT_CROP --left-crop LEFT_CROP
Left crop Left crop
--right-crop RIGHT_CROP --right-crop RIGHT_CROP