Add installation docs (#506)

This commit is contained in:
Chidi Williams 2023-06-23 10:43:29 +01:00 committed by GitHub
commit fa08e5344e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,6 +1,6 @@
# Buzz
[Documentation](https://chidiwilliams.github.io/buzz/) | [Buzz Captions on the App Store](https://apps.apple.com/us/app/buzz-captions/id6446018936?mt=12&itsct=apps_box_badge&itscg=30200)
[Documentation](https://chidiwilliams.github.io/buzz/) | [Buzz Captions on the App Store](https://apps.apple.com/us/app/buzz-captions/id6446018936?mt=12&itsct=apps_box_badge&itscg=30200)
Transcribe and translate audio offline on your personal computer. Powered by
OpenAI's [Whisper](https://github.com/openai/whisper).
@ -17,3 +17,22 @@ OpenAI's [Whisper](https://github.com/openai/whisper).
</blockquote>
![Buzz](./assets/buzz-banner.jpg)
## Installation
**macOS**:
```shell
brew install --cask buzz
```
**Windows**:
Download and run the `.exe` file in the [releases page](https://github.com/chidiwilliams/buzz/releases/latest).
**Linux**:
```shell
sudo apt-get install libportaudio2
sudo snap install buzz
```