Skip to content

Add development setup section to README - #584

Merged
Breakthrough merged 1 commit into
Breakthrough:mainfrom
vishal-tambi:docs/readme-dev-setup
Oct 21, 2026
Merged

Breakthrough merged 1 commit into
Breakthrough:mainfrom
vishal-tambi:docs/readme-dev-setup

Conversation

@vishal-tambi

Copy link
Copy Markdown
Contributor

Adds a short Development Setup section to the README. It covers the editable install, fetching the test videos from the resources branch without staging them, and using python -m scenedetect, since dev installs don't include the scenedetect command. I ran each command in a fresh clone on Windows. ffmpeg doesn't need to be on PATH because the tests fall back to the copy from imageio-ffmpeg, so only mkvmerge has to be installed separately.

@Breakthrough Breakthrough left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the addition - sent you one clarifying question before approval.

Comment thread README.md

@Breakthrough Breakthrough left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR 👍

@Breakthrough
Breakthrough merged commit 0744735 into Breakthrough:main Oct 21, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants