Skip to content

Commit 872a84f

Browse files
committed
Add Lazy usage instructions to README
1 parent 0ae8066 commit 872a84f

File tree

1 file changed

+37
-5
lines changed

1 file changed

+37
-5
lines changed

README.md

+37-5
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,43 @@
22

33
Resync Chapters by snapping them to Scene Changes.
44

5-
## To-do
6-
7-
- [x] Automatically replace the chapters in the input video container.
8-
9-
Likely lot's more.
5+
## Usage
6+
7+
```
8+
Usage: chapsnap [OPTIONS] VIDEO [CHAPTERS]
9+
10+
Snap Chapters to Scene Changes.
11+
12+
VIDEO The video file to snap chapters to scene changes. All video formats are
13+
supported. You may alternatively provide a directory path to process
14+
video files in batch.
15+
[CHAPTERS] Optional chapters file if you want to use chapters from a file
16+
rather than ones already muxed with the video.
17+
18+
Options:
19+
-t, --threshold FLOAT Threshold on Scene Change probability scores. The
20+
lower the value, the more unlikely the frame is to be
21+
a Scene Change. Range: 0.0 (Impossible) - 1.0
22+
(Definite).
23+
-o, --offset FLOAT Offset to apply to each Chapter. A negative offset
24+
may result in fewer Chapters.
25+
--trim INTEGER Remove n Chapters from the start of the Video. A
26+
negative value will remove n Chapters from the end of
27+
the Video. Timestamps will be offset respectively.
28+
-nf, --no-forward Do not try to resync Chapters forward in time.
29+
-nb, --no-backward Do not try to resync Chapters backward in time.
30+
-k, --keyframes Only sync to Scene Changes on Keyframes (I-frames).
31+
-0, --zero Force the first chapter to be at `00:00:00.000`, even
32+
after offsets and trims.
33+
-c, --chain Chain sync adjustments from one Chapter to the next.
34+
E.g., Chapter 1 had -2, so Chapter 2 will begin with
35+
an offset of -2. Chapter 2 with -2 has a change of
36+
-1, so Chapter 3 will begin with an offset of -3 and
37+
so on.
38+
--overwrite Apply new Chapters to the input video file in-place,
39+
without making a duplicate.
40+
--help Show this message and exit.
41+
```
1042

1143
## Contributors
1244

0 commit comments

Comments
 (0)