feat: update readme
This commit is contained in:
parent
f6a5d41dfe
commit
40baeb3c39
28
README.md
28
README.md
@ -7,14 +7,13 @@ A CLI to generate comparison image sets with
|
|||||||
```
|
```
|
||||||
usage: FrameForge [-h] [-v] [--source SOURCE] [--encode ENCODE] [--frames FRAMES]
|
usage: FrameForge [-h] [-v] [--source SOURCE] [--encode ENCODE] [--frames FRAMES]
|
||||||
[--image-dir IMAGE_DIR] [--indexer {lsmash,ffms2}]
|
[--image-dir IMAGE_DIR] [--indexer {lsmash,ffms2}]
|
||||||
[--index-dir INDEX_DIR] [--sub-size SUB_SIZE] [--left-crop LEFT_CROP]
|
[--source-index-path SOURCE_INDEX_PATH]
|
||||||
[--right-crop RIGHT_CROP] [--top-crop TOP_CROP]
|
[--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] [--adv-resize-left ADV_RESIZE_LEFT]
|
[--bottom-crop BOTTOM_CROP] [--adv-resize-left ADV_RESIZE_LEFT]
|
||||||
[--adv-resize-right ADV_RESIZE_RIGHT]
|
[--adv-resize-right ADV_RESIZE_RIGHT] [--adv-resize-top ADV_RESIZE_TOP]
|
||||||
[--adv-resize-top ADV_RESIZE_TOP]
|
[--adv-resize-bottom ADV_RESIZE_BOTTOM] [--tone-map] [--re-sync RE_SYNC]
|
||||||
[--adv-resize-bottom ADV_RESIZE_BOTTOM] [--tone-map]
|
[--comparison-count COMPARISON_COUNT] [--subtitle-color SUBTITLE_COLOR]
|
||||||
[--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:
|
||||||
@ -22,14 +21,16 @@ 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,
|
--frames FRAMES Only use this if you want to specify the frames to generate, this
|
||||||
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}
|
||||||
Indexer choice
|
Indexer choice
|
||||||
--index-dir INDEX_DIR
|
--source-index-path SOURCE_INDEX_PATH
|
||||||
Path to look/create indexes
|
Path to look/create indexes for source
|
||||||
|
--encode-index-path ENCODE_INDEX_PATH
|
||||||
|
Path to look/create indexes for encode
|
||||||
--sub-size SUB_SIZE Size of subtitles
|
--sub-size SUB_SIZE Size of subtitles
|
||||||
--left-crop LEFT_CROP
|
--left-crop LEFT_CROP
|
||||||
Left crop
|
Left crop
|
||||||
@ -51,10 +52,9 @@ options:
|
|||||||
--comparison-count COMPARISON_COUNT
|
--comparison-count COMPARISON_COUNT
|
||||||
Amount of comparisons to generate
|
Amount of comparisons to generate
|
||||||
--subtitle-color SUBTITLE_COLOR
|
--subtitle-color SUBTITLE_COLOR
|
||||||
Hex color code for subtitle color
|
Hex color code for subtitle color (i.e. --subtitle-color "#fff000")
|
||||||
--release-sub-title RELEASE_SUB_TITLE
|
--release-sub-title RELEASE_SUB_TITLE
|
||||||
Release group subtitle name (this will show on the encode
|
Release group subtitle name (this will show on the encode images)
|
||||||
images)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Supports
|
## Supports
|
||||||
|
Loading…
Reference in New Issue
Block a user