kanjieater / SubPlz

🫴 Generate, sync, and manage subtitle files for any media; Generate your own audiobook subs similar to Kindle's Immersion Reading 📖🎧
MIT License
90 stars 9 forks source link

Having a hard time determining what SubPlz does #16

Open etherealite opened 13 hours ago

etherealite commented 13 hours ago

Based on the README.md I am having hard time figuring out what this project does.

At first glance it's hard to tell if this is simply a wrapper around whisper to generate new subs and or is it a wrapper around alass if you already have subs. It appears to me that it is doing more than those things.

It appears to me that SubPlz will generate a timing reference using whisper and then use that with alass to sync your original subs. Am I correct on that?

I think defining the types of scenarios that this tool is meant to handle in the beginning of the readme would be helpful.

Perhaps something like:

Easily generate, sync, and manage subtitle files for any media type with special features for working with audiobooks and videos.

## Features
- **Sync Existing Subtitles**: By integrating multiple techniques to synchronize your subtitles, SubPlz lets you select and apply the most accurate method available.
- **Create New Subtitles**: Generate new subtitles from the audio of any media file.
- **File Management**: Automatically organize and rename your subtitles to match your media files.
- **Video Subtitle Swapping**: Easily swap which subtitles are applied to a video file in your media player.
- **Accurately Subtitle Narrated Media**: Leverage the original source text of an ebook to provide highly accurate subtitles.

These features could than be further described with references to the underlying technologies.

kanjieater commented 12 hours ago

Thanks for the feedback. I think you got things mostly right. I shifted things around and tried to clarify more appropriately. I should really probably just make a video at some point.

image Here's the updated readme, I hope this helps.