From 070d9f17d576716d98e1945425bb7414011d14a4 Mon Sep 17 00:00:00 2001 From: Raivis Dejus Date: Sun, 9 Nov 2025 21:57:39 +0200 Subject: [PATCH] Documentation adjustments (#1281) --- .github/workflows/ci.yml | 73 ++++++++++--------- README.md | 48 ++++++------ docs/docs/faq.md | 2 +- .../io.github.chidiwilliams.Buzz.metainfo.xml | 2 +- 4 files changed, 60 insertions(+), 65 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dbfa02f0..010e183a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -357,40 +357,41 @@ jobs: with: files: | Buzz*-unix.tar.gz - Buzz*-windows.exe - Buzz*-windows-*.bin - Buzz*-mac.dmg + Buzz*.exe + Buzz*.bin + Buzz*.dmg - deploy_brew_cask: - runs-on: macos-latest - env: - BUZZ_DISABLE_TELEMETRY: true - needs: [release] - if: startsWith(github.ref, 'refs/tags/') - steps: - - uses: actions/checkout@v4 - with: - submodules: recursive - - # Should be removed with next update to whisper.cpp - - name: Downgrade Xcode - uses: maxim-lobanov/setup-xcode@v1 - with: - xcode-version: '16.0.0' - if: matrix.os == 'macos-latest' - - - name: Install uv - uses: astral-sh/setup-uv@v6 - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: "3.12" - - - name: Install dependencies - run: uv sync - - - name: Upload to Brew - run: uv run make upload_brew - env: - HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} +# Brew Cask deployment fails and the app is deprecated on Brew. +# deploy_brew_cask: +# runs-on: macos-latest +# env: +# BUZZ_DISABLE_TELEMETRY: true +# needs: [release] +# if: startsWith(github.ref, 'refs/tags/') +# steps: +# - uses: actions/checkout@v4 +# with: +# submodules: recursive +# +# # Should be removed with next update to whisper.cpp +# - name: Downgrade Xcode +# uses: maxim-lobanov/setup-xcode@v1 +# with: +# xcode-version: '16.0.0' +# if: matrix.os == 'macos-latest' +# +# - name: Install uv +# uses: astral-sh/setup-uv@v6 +# +# - name: Set up Python +# uses: actions/setup-python@v5 +# with: +# python-version: "3.12" +# +# - name: Install dependencies +# run: uv sync +# +# - name: Upload to Brew +# run: uv run make upload_brew +# env: +# HOMEBREW_GITHUB_API_TOKEN: ${{ secrets.HOMEBREW_GITHUB_API_TOKEN }} diff --git a/README.md b/README.md index 173d25e4..55c62f9d 100644 --- a/README.md +++ b/README.md @@ -22,26 +22,9 @@ OpenAI's [Whisper](https://github.com/openai/whisper). ## Installation -### PyPI - -Install [ffmpeg](https://www.ffmpeg.org/download.html) - -Install Buzz - -```shell -pip install buzz-captions -python -m buzz -``` - ### macOS -Install with [brew utility](https://brew.sh/) - -```shell -brew install --cask buzz -``` - -Or download the `.dmg` from the [SourceForge](https://sourceforge.net/projects/buzz-captions/files/). +Download the `.dmg` from the [SourceForge](https://sourceforge.net/projects/buzz-captions/files/). ### Windows @@ -55,15 +38,6 @@ App is not signed, you will get a warning when you install it. Select `More info winget install ChidiWilliams.Buzz ``` -**GPU support for PyPI** - -To have GPU support for Nvidia GPUS on Windows, for PyPI installed version ensure, CUDA support for [torch](https://pytorch.org/get-started/locally/) - -``` -pip3 install -U torch==2.7.1+cu128 torchaudio==2.7.1+cu128 --index-url https://download.pytorch.org/whl/cu128 -pip3 install nvidia-cublas-cu12==12.8.3.14 nvidia-cuda-cupti-cu12==12.8.57 nvidia-cuda-nvrtc-cu12==12.8.61 nvidia-cuda-runtime-cu12==12.8.57 nvidia-cudnn-cu12==9.7.1.26 nvidia-cufft-cu12==11.3.3.41 nvidia-curand-cu12==10.3.9.55 nvidia-cusolver-cu12==11.7.2.55 nvidia-cusparse-cu12==12.5.4.2 nvidia-cusparselt-cu12==0.6.3 nvidia-nvjitlink-cu12==12.8.61 nvidia-nvtx-cu12==12.8.55 --extra-index-url https://pypi.ngc.nvidia.com -``` - ### Linux Buzz is available as a [Flatpak](https://flathub.org/apps/io.github.chidiwilliams.Buzz) or a [Snap](https://snapcraft.io/buzz). @@ -80,6 +54,26 @@ sudo snap install buzz sudo snap connect buzz:password-manager-service ``` +### PyPI + +Install [ffmpeg](https://www.ffmpeg.org/download.html) + +Install Buzz + +```shell +pip install buzz-captions +python -m buzz +``` + +**GPU support for PyPI** + +To have GPU support for Nvidia GPUS on Windows, for PyPI installed version ensure, CUDA support for [torch](https://pytorch.org/get-started/locally/) + +``` +pip3 install -U torch==2.7.1+cu128 torchaudio==2.7.1+cu128 --index-url https://download.pytorch.org/whl/cu128 +pip3 install nvidia-cublas-cu12==12.8.3.14 nvidia-cuda-cupti-cu12==12.8.57 nvidia-cuda-nvrtc-cu12==12.8.61 nvidia-cuda-runtime-cu12==12.8.57 nvidia-cudnn-cu12==9.7.1.26 nvidia-cufft-cu12==11.3.3.41 nvidia-curand-cu12==10.3.9.55 nvidia-cusolver-cu12==11.7.2.55 nvidia-cusparse-cu12==12.5.4.2 nvidia-cusparselt-cu12==0.6.3 nvidia-nvjitlink-cu12==12.8.61 nvidia-nvtx-cu12==12.8.55 --extra-index-url https://pypi.ngc.nvidia.com +``` + ### Latest development version For info on how to get latest development version with latest features and bug fixes see [FAQ](https://chidiwilliams.github.io/buzz/docs/faq#9-where-can-i-get-latest-development-version). diff --git a/docs/docs/faq.md b/docs/docs/faq.md index 10d74409..4de7f377 100644 --- a/docs/docs/faq.md +++ b/docs/docs/faq.md @@ -84,7 +84,7 @@ gsettings set org.gnome.desktop.interface color-scheme prefer-dark If your system theme is not applied to Buzz installed from Flatpak Linux app store, ensure the desired theme is in `~/.themes` folder. -You may need to copy the system themes to this folder `cp -r /usr/share/themes/ ~/.themes/`. +You may need to copy the system themes to this folder `cp -r /usr/share/themes/ ~/.themes/` and give Flatpaks access to this folder `flatpak override --user --filesystem=~/.themes`. On Fedora run the following to install the necessary packages `sudo dnf install gnome-themes-extra qadwaitadecorations-qt{5,6} qt{5,6}-qtwayland` \ No newline at end of file diff --git a/share/metainfo/io.github.chidiwilliams.Buzz.metainfo.xml b/share/metainfo/io.github.chidiwilliams.Buzz.metainfo.xml index 5faf4bcc..d65251fd 100644 --- a/share/metainfo/io.github.chidiwilliams.Buzz.metainfo.xml +++ b/share/metainfo/io.github.chidiwilliams.Buzz.metainfo.xml @@ -16,7 +16,7 @@ Required permissions in Buzz will let you select audio and video files for transcription, from most common file location on your computer. Network permission is used to download transcription model files. Microphone permission lets you transcribe real time speech.

- Note: If your system theme is not applied to Buzz, ensure it is in ~/.themes folder. You may need to copy the system themes to this folder cp -r /usr/share/themes/ ~/.themes/. + Note: If your system theme is not applied to Buzz, ensure it is in ~/.themes folder. You may need to copy the system themes to this folder cp -r /usr/share/themes/ ~/.themes/ and give Flatpaks access to this folder flatpak override --user --filesystem=~/.themes.