Skip to content

Add README requirements and common setup issues#18

Open
khanfs wants to merge 1 commit intofacebookresearch:mainfrom
khanfs:docs/readme-clarifications
Open

Add README requirements and common setup issues#18
khanfs wants to merge 1 commit intofacebookresearch:mainfrom
khanfs:docs/readme-clarifications

Conversation

@khanfs
Copy link
Copy Markdown

@khanfs khanfs commented Apr 1, 2026

Summary

This PR improves the README for new users by adding setup requirements and a short troubleshooting section for common setup issues.

Changes

  • add a Requirements section
  • add a Common setup issues section
  • document practical setup details around environment setup, ffmpeg, and Hugging Face access

Why

Add practical setup details for first-time users that are not explicitly documented.

@meta-cla meta-cla bot added the CLA Signed This label is managed by the Meta Open Source bot. label Apr 1, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed This label is managed by the Meta Open Source bot.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant