Skip to content

Commit ec843bb

Browse files
committed
updated readme to reference new chapconv cli tool
1 parent 35f43b7 commit ec843bb

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

.github/readme.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -32,18 +32,20 @@ Create and _convert_ chapters for podcasts, youtube, matroska, mkvmerge/nero/vor
3232
| Apple HLS Chapters | applehls | `json` | [spec](https://developer.apple.com/documentation/http-live-streaming/providing-javascript-object-notation-json-chapters), partial support |
3333
| SceneCut | scenecut | `json` | [spec](https://github.com/slhck/scenecut-extractor#:~:text=cuts%20in%20JSON-,format,-%3A) |
3434

35-
## CLI
35+
## CLI
3636

3737
## Prerequisite
3838

3939
You need to install `node` and optionally `ffmpeg` on your system:
4040

41-
Windows: [modern terminal](https://github.com/microsoft/terminal), [package manager](https://chocolatey.org/), [node](https://www.startpage.com/sp/search?q=windows%20install%20node), [ffmpeg](https://www.startpage.com/sp/search?q=windows%20install%20ffmpeg)
42-
macOS: [package manager](https://brew.sh/), [node](https://www.startpage.com/sp/search?q=macOS%20install%20node), [ffmpeg](https://www.startpage.com/sp/search?q=macOS%20install%20ffmpeg)
41+
Windows: [modern terminal](https://github.com/microsoft/terminal), [package manager](https://chocolatey.org/), [node](https://www.startpage.com/sp/search?q=windows%20install%20node), [ffmpeg](https://www.startpage.com/sp/search?q=windows%20install%20ffmpeg)
42+
macOS: [package manager](https://brew.sh/), [node](https://www.startpage.com/sp/search?q=macOS%20install%20node), [ffmpeg](https://www.startpage.com/sp/search?q=macOS%20install%20ffmpeg)
4343
linux: [node](https://www.startpage.com/sp/search?q=linux%20install%20node), [ffmpeg](https://www.startpage.com/sp/search?q=linux%20install%20ffmpeg)
4444

4545
## create chapters from video
4646

47+
> An updated cli tool with better interface is available here: [chapconv](https://github.com/Mtillmann/chapconv)
48+
4749
```shell
4850
npx chaptertool@latest generate YOUR_FILE.mp4
4951
```
@@ -69,7 +71,7 @@ Generate raw chapters from video using ffmpeg.
6971
| `<input>` | the video file that you want to process | |
7072
| `--y` | when set ffmpeg will _always_ overwrite existing output | |
7173
| `--n` | when set ffmpeg will _never_ overwrite existing output | |
72-
| `--output-format` | output format for the chapters, [see below](#convert) | `chaptersjson` |
74+
| `--output-format` | output format for the chapters, [see below](#convert) | `chaptersjson` |
7375
| `--output-folder` | image destination folder, `$filename` will be replaced with the input video filename minus the extension | `$filename_chapters` |
7476
| `--chapter-template` | template string for the chapter names. | `Chapter $chapter of $total` |
7577
| `--scene-value` | min value for ffmpeg's scene detection. If you only use a small portion of the screen, the value should be smaller. See the crop option | `0.1` |
@@ -111,7 +113,7 @@ Converts existing chapters between any of the supported formats:
111113
| `--psd-framerate` | set the framerate for _PySceneDetect_ output | |
112114
| `--ac-use-text-attr` | use the text-attribute for _Apple Chapters_ | |
113115

114-
> use `--output-file` when using powershell, otherwise you'll have BOMs in your output
116+
> use `--output-file` when using powershell, otherwise you'll have BOMs in your output
115117
116118
## config yaml and .env
117119

@@ -143,7 +145,7 @@ You can combine config with regular cli options. Evaluation occurs in this order
143145

144146
[examples.md](/examples.md), [FAQ](/faq.md)
145147

146-
## Docker
148+
## Docker
147149

148150
Use docker to run the web GUI:
149151

0 commit comments

Comments
 (0)