Translations for IRBCAM Client

Thank you for your interest in helping us translate IRBCAM. We appreciate your contributions in making IRBCAM more accessible to users around the world. This README provides information on how to get started with translating the user interface (UI) and submitting your translations as Pull Requests (PRs).

Getting Started

Install Git

Install git on your computer. Most Linux distros and MacOS already come with git installed. For Windows, you can find an installer here.

Fork the Repository

1. Fork this repository to your own GitHub account by clicking the "Fork" button at the top of this page.

Clone Your Fork

1. Clone the repository from your GitHub account to your local machine. Replace [your_username] with your GitHub username.

   git clone https://github.com/[your_username]/irbcam-language-files.git

2. Navigate to the project directory:

   cd [repository_name]

Prepare Your Tools

Translations are stored in irbcam_XX.ts files, where XX corresponds to the ISO 639-1 language code for a given language. The files are formatted as XML and the easiest way is to edit with the Qt Linguist application. You can either get Linguist by installing Qt developer tools, or by using a standalone installer.

Standalone Installers

• Official Linguist installer for Windows
• Official Flatpak for Linux
• Third party Windows/MacOS installers

Translate

Add or modify translations to the file(s) you want to edit. You can look in the user manual for Qt Linguist for instructions on how to use it. When you are done, save the file.

Submit Your Translation

1. Commit your changes with a meaningful commit message:

   git add
   git commit -m "Updated translation for [Language Name]"

2. Push the changes to your GitHub repository:

   git push

Create a Pull Request

1. Visit your GitHub repository and click on the "New Pull Request" button.
2. Choose the original repository (the one you forked from) as the base repository and your fork as the head repository.
3. Describe your changes and submit the Pull Request.

Guidelines

• Use clear and consistent translations.
• Be mindful of context and ensure translations make sense within the UI.
• If you encounter any techical or terminology-related issues, feel free to ask questions in the Pull Request.
• We appreciate your help and will review your contributions as soon as possible.

Contact

If you have any questions or ned assistance, please feel free to reach out to us on our discussion forum.

Thank you for helping us make IRBCAM accessible to a global audience!