chore(README): add note about ffmpeg [skip ci]

Signed-off-by: yshalsager <ysh-alsager@hotmail.com>
yshalsager · Mar 7, 2022 · 0dd4dc7 · 0dd4dc7
1 parent 0563a44
commit 0dd4dc7
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -58,4 +58,5 @@ dmypy.json
 config.json
 *.txt
 *.mp*
-*.m4a
+*.m4a
+*.exe
diff --git a/README.md b/README.md
@@ -21,6 +21,8 @@ A mini command line tool to transcribe media files using [wit.ai](https://wit.ai
 
 ## Usage
 
+**Note**: ffmpeg must be installed!
+
 Copy config example file to `config.json` and add required languages API keys you got from the previous step.
 
 ```bash
@@ -58,7 +60,8 @@ options:
 ### تشغيل اﻷداة على ويندوز
 
 - حمل أحدث نسخة من الملف التنفيذي للأداة من [هنا](https://github.com/yshalsager/wit_transcriber/releases/latest).
-- قم بتشغيل الملف التنفيذي عبر سطر/موجه اﻷوامر مع استبدال كلمة filename باسم الملف المراد تدقيقه.
+- حمل ملفات ffmpeg إذا لم يكن مثبتا عندك من [هنا](https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.7z) وفك الضغط عن الملف ثم انقل `ffmpeg.exe` و `ffprobe.exe` إلى نفس المجلد الذي به الأداة.
+- شغل الملف التنفيذي عبر سطر/موجه اﻷوامر مع استبدال كلمة filename باسم الملف المراد تفريغه.
 
 ```powershell
 ./wit_transcriber.exe -i filename
-Original file line number
+Diff line change
@@ Expand Up / @@ -58,4 +58,5 @@ dmypy.json @@
     config.json
     *.txt
     *.mp*
-    *.m4a
+    *.m4a
+    *.exe