added installation instructions

This commit is contained in:
EliasVincent 2023-03-10 11:47:16 +01:00
parent a24fa781f1
commit 1c0bda33fb

View File

@ -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
```