Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 3.5 KB

CONTRIBUTING.md

File metadata and controls

84 lines (63 loc) · 3.5 KB
Raw

Buzz Contribution Guide

Internationalization

To contribute a new language translation to Buzz:

  1. Run make translation_po locale=[locale]. [locale] is a string with the format "language[_script][_country]", where:

    • "language" is a lowercase, two-letter ISO 639 language code,
    • "script" is a titlecase, four-letter, ISO 15924 script code, and
    • "country" is an uppercase, two-letter, ISO 3166 country code.

    For example: make translation_po locale=en_US.

  2. Fill in the translations in the .po file generated in locale/[locale]/LC_MESSAGES.

  3. Run make translation_mo to compile the translations, then test your changes.

  4. Create a new pull request with your changes.

Troubleshooting

If you encounter any issues, please open an issue on the Buzz GitHub repository. Here are a few tips to gather data about the issue, so it is easier for us to fix.

Provide details

What version of the Buzz are you using? On what OS? What are steps to reproduce it? What settings were selected.

Logs

Log files contain valuable information about what the Buzz was doing before the issue occurred. You can get the logs like this:

  • Mac and Linux run the app from the terminal and check the output.
  • Windows paste this into the Windows Explorer address bar %USERPROFILE%\AppData\Local\Buzz\Buzz\Logs and check the logs file.

Running Buzz locally

Linux (Ubuntu)

  1. Clone the repository git clone --recursive https://github.com/chidiwilliams/buzz.git
  2. Enter repo folder cd buzz
  3. Install Poetry apt-get install python3-poetry
  4. Activate the virtual environment poetry shell
  5. Install the dependencies poetry install
  6. Install system dependencies you may be missing
sudo apt-get install --no-install-recommends libyaml-dev libegl1-mesa libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-shape0 libxcb-cursor0 libportaudio2 gettext libpulse0
  1. Build Buzz poetry build
  2. Run Buzz python -m buzz

Windows

Assumes you have Git and python <3.11 installed and added to PATH.

  1. Install the chocolatey package manager for Windows. More info
Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
  1. Install the GNU make. choco install make
  2. Install the ffmpeg. choco install ffmpeg
  3. Install Poetry, paste this info Windows PowerShell line by line. More info
(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

[Environment]::SetEnvironmentVariable("Path", $env:Path + ";%APPDATA%\pypoetry\venv\Scripts", "User")

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

  1. Restart Windows.

  2. Clone the repository git clone --recursive https://github.com/chidiwilliams/buzz.git

  3. Enter repo folder cd buzz

  4. Copy whisper.dll from the repo backup to buzz folder.

cp .\dll_backup\whisper.dll .\buzz\
  1. Activate the virtual environment poetry shell
  2. Install the dependencies poetry install
  3. Build Buzz poetry build
  4. Install Buzz
$whlFile = Get-ChildItem .\dist\buzz*.whl | Select-Object -First 1
pip install $whlFile
  1. Run Buzz python -m buzz