docs: add note about ffmpeg dependency and RuntimeWarning#1687
Open
Saurabhtbj1201 wants to merge 1 commit intomicrosoft:mainfrom
Open
docs: add note about ffmpeg dependency and RuntimeWarning#1687Saurabhtbj1201 wants to merge 1 commit intomicrosoft:mainfrom
Saurabhtbj1201 wants to merge 1 commit intomicrosoft:mainfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Subject: docs: add note about
ffmpegdependency andRuntimeWarningDescription:
What does this PR do?
This PR updates the
README.mdto clarify the system requirements for Audio transcription.Currently,
markitdowntriggers aRuntimeWarning: Couldn't find ffmpeg or avconv...when users run conversions on systems withoutffmpeginstalled (sincepydubattempts to look for it). Adding a brief note about this dependency saves new users from confusion when they see this warning text in the terminal during general CLI usage.Changes
README.mdunder the "Audio" section to mentionffmpeg/avconvprerequisites.RuntimeWarningdirectly so it can be easily found via search.Checklist
pre-commithooks locally to ensure formatting and linting pass.testsrun successfully.