From 1c0bda33fb713ad7d3811300babf606e57253e8d Mon Sep 17 00:00:00 2001
From: EliasVincent <riesyeti@outlook.de>
Date: Fri, 10 Mar 2023 11:47:16 +0100
Subject: [PATCH] added installation instructions

---
 extensions/whisper_stt/README.md | 39 ++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 extensions/whisper_stt/README.md

diff --git a/extensions/whisper_stt/README.md b/extensions/whisper_stt/README.md
new file mode 100644
index 0000000000..068f5dda11
--- /dev/null
+++ b/extensions/whisper_stt/README.md
@@ -0,0 +1,39 @@
+# Installation instructions
+
+- On all platforms, run `pip install -r requirements.txt` in this folder
+- You need **PortAudio** to run the speech recognition. Below are guides for all platforms
+
+
+## Windows
+
+- You don't need to do anything, `pyaudio` already comes with PortAudio included on Windows.
+
+## Mac
+
+```commandline
+brew install portaudio
+brew link --overwrite portaudio
+pip install pyaudio
+```
+
+## Linux
+
+- You have to use your distro's package manager to install PortAudio.
+
+### Ubuntu / Debian / Mint
+
+```commandline
+sudo apt install portaudio19-dev python3-pyaudio
+```
+
+### Arch / Manjaro
+
+```commandline
+sudo pacman -S portaudio
+```
+
+### Fedora
+
+```commandline
+sudo dnf -y install portaudio
+```
\ No newline at end of file