Skip to content

Commit

Permalink
updated README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
clash82 committed Aug 29, 2024
1 parent 1cf3ab5 commit 6d8d906
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,32 @@ rBiblia for Windows locales

![linter](https://github.com/rBiblia/rbiblia-windows-locales/actions/workflows/lint.yaml/badge.svg)

Localisation repository for [rBiblia](https://rbiblia.toborek.info) application.
Localisation repository for the [rBiblia](https://rbiblia.toborek.info/en-US/) application.

All contributions are welcome.

Here you will find details on how to translate rBiblia's interface into your language.

Step by step instruction
------------------------
Step-by-Step Instructions
-------------------------

* start your work by forking this repository,
* create a new branch for your work,
* create a new folder using language culture specific name (eg. `pl-PL`, `en-GB`, `fr-FR` etc.),
* copy all files included in `en-GB` folder to your new location,
* start your work by opening `translation.xml` file in your favorite text editor (eg. Notepad),
* change (or add a new one) name under `<authors></authors>` tags. Name between `<name></name>` tags will be shown in the About box of the Language settings window,
* start translating strings stored between `<value id="..." type="..."></value>` tags. Please, do not change anything beyond this area, especially do not touch `id` or `type` attributes.
* after your work is done, you can add a new commit with the proper name, for example `[en-GB] added interface translation file` - all your commits should be preceded with culture specific id stored between `[`square brackets`]`,
* push your local branch to your fork and create a new Pull Request.
* Start your work by forking this repository.
* Create a new branch for your work.
* Create a new folder using a language culture-specific name (e.g., `pl-PL`, `en-GB`, `fr-FR`, etc.).
* Copy all files included in the `en-GB` folder to your new location.
* Start your work by opening the `translation.xml` file in your favorite text editor (e.g., Notepad).
* Change (or add a new) name under the `<authors></authors>` tags. The name between the `<name></name>` tags will be shown in the About box of the Language settings window.
* Start translating strings stored between the `<value id="..." type="..."></value>` tags. Please do not change anything beyond this area, especially do not touch the `id` or `type` attributes.
* After your work is done, you can add a new commit with the proper name, for example, `[en-GB] added interface translation file` - all your commits should be preceded with the culture-specific ID stored between `[`square brackets`]`.
* Push your local branch to your fork and create a new Pull Request.

After successful review of your Pull Request, your commits will be merged into master branch of the upstream repository.
After a successful review of your Pull Request, your commits will be merged into the master branch of the upstream repository.

Only two files are required to translate rBiblia's interface: `translation.xml` and `aliases.xml`.

If you have any questions, please do not hestitate to contact the author of this repository.
If you have any questions, please do not hesitate to contact the author of this repository.

You can drop me a line using dedicated [contact form](https://kontakt.toborek.info) (please keep in mind that I can understand only Polish and English language).
You can drop me a line using the dedicated [contact form](https://kontakt.toborek.info) (please keep in mind that I can understand only Polish and English).

Please [support my work](https://rbiblia.toborek.info/donation/).

Expand Down

0 comments on commit 6d8d906

Please sign in to comment.