Skip to content

Commit

Permalink
added installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
EliasVincent committed Mar 10, 2023
1 parent a24fa78 commit 1c0bda3
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions extensions/whisper_stt/README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 1c0bda3

Please sign in to comment.