From fa08e5344e7b400b4afd10c692dbaedea1aba2c8 Mon Sep 17 00:00:00 2001 From: Chidi Williams Date: Fri, 23 Jun 2023 10:43:29 +0100 Subject: [PATCH] Add installation docs (#506) --- README.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5432a04e..06bfe424 100644 --- a/README.md +++ b/README.md @@ -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). ![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 +```