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

feat: update readme

Browse Source
This commit is contained in:
jlw4049 2024-03-01 16:32:55 -05:00
parent 1f329677f7
commit 3f06777a29
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -5,13 +5,16 @@ A CLI to generate comparison image sets with
## Usage ## Usage
``` ```
usage: Comparison Image Generator [-h] [-v] [--source SOURCE] [--encode ENCODE] [--image-dir IMAGE_DIR] usage: FrameForge [-h] [-v] [--source SOURCE] [--encode ENCODE] [--frames FRAMES]
[--indexer {lsmash,ffms2}] [--index-dir INDEX_DIR] [--sub-size SUB_SIZE] [--image-dir IMAGE_DIR] [--indexer {lsmash,ffms2}]
[--left-crop LEFT_CROP] [--right-crop RIGHT_CROP] [--top-crop TOP_CROP] [--index-dir INDEX_DIR] [--sub-size SUB_SIZE] [--left-crop LEFT_CROP]
[--right-crop RIGHT_CROP] [--top-crop TOP_CROP]
[--bottom-crop BOTTOM_CROP] [--adv-resize-left ADV_RESIZE_LEFT] [--bottom-crop BOTTOM_CROP] [--adv-resize-left ADV_RESIZE_LEFT]
[--adv-resize-right ADV_RESIZE_RIGHT] [--adv-resize-top ADV_RESIZE_TOP] [--adv-resize-right ADV_RESIZE_RIGHT]
[--adv-resize-bottom ADV_RESIZE_BOTTOM] [--tone-map] [--re-sync RE_SYNC] [--adv-resize-top ADV_RESIZE_TOP]
[--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:
@ -19,6 +22,8 @@ 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 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}
@ -48,7 +53,8 @@ options:
--subtitle-color SUBTITLE_COLOR --subtitle-color SUBTITLE_COLOR
Hex color code for subtitle color Hex color code for subtitle color
--release-sub-title RELEASE_SUB_TITLE --release-sub-title RELEASE_SUB_TITLE
Release group subtitle name (this will show on the encode images) Release group subtitle name (this will show on the encode
images)
``` ```
## Supports ## Supports