Skip to content

Commit

Permalink
Update readme for table of contents (#63)
Browse files Browse the repository at this point in the history
Co-authored-by: Shun Liang <[email protected]>
  • Loading branch information
shun-liang and shun-liang authored Nov 10, 2024
1 parent 9706409 commit 201ec29
Show file tree
Hide file tree
Showing 2 changed files with 100 additions and 73 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,16 @@ Or install with [uv](https://github.com/astral-sh/uv):
uv tool install yt2doc
```

#### ⚠️ Know issue of Python 3.13 on MacOS

If you are on MacOS and running Python 3.13, you may face a dependency issue that is from the upstream PyTorch dependency. See issue [#46](https://github.com/shun-liang/yt2doc/issues/46).

A quick workaround will be

```
pipx install --python 3.12 yt2doc
```

### Upgrade

If you have already installed yt2doc but would like to upgrade to a later version:
Expand Down Expand Up @@ -158,6 +168,13 @@ Paragraphs in the generated Markdown can be timestamped by
yt2doc --video <video-url> --timestamp-paragraphs
```

### Add table of contents

A table of contents of all chapters can be added by
```
yt2doc --video <video-url> --segment-unchaptered --llm-model <llm-model> --add-table-of-contents
```

### Ignore chapters from source

Sometimes, the chaptering of the video/audio at the source does not segment the content in the way you are happy about. You can ask yt2doc to ignore the source chaptering by
Expand Down
Loading

0 comments on commit 201ec29

Please sign in to comment.