1
0
mirror of https://github.com/billz/raspap-webgui.git synced 2023-10-10 13:37:24 +02:00

Update contributing

Bill Zimmerman 2020-04-05 11:19:56 +02:00
parent e5ce4f202b
commit 703b22f041

@ -1,4 +1,4 @@
### RaspAP in your language
## RaspAP in your language
Owing to its utility and low cost, the Raspberry Pi's reach extends to all corners of the globe. As our way of honoring this, we've made an effort to support internationalization (often abbreviated **i18n**) with RaspAP. Given the response from [this issue](https://github.com/billz/raspap-webgui/issues/121) it became obvious that translations are something that the community both wanted and were willing to contribute to.
On Linux systems, [GNU's Gettext](https://www.gnu.org/software/gettext/) provides a standardized way of managing multi-lingual messages. In order for Gettext to work with different languages, you must configure a language package on your RPi corresponding to one of our supported translations.
@ -40,7 +40,7 @@ Once you've configured a locale on your system, RaspAP will read the `HTTP_ACCEP
sudo systemctl restart lighttpd.service
```
### Supported languages
## Supported languages
The following translations are currently maintained by the project:
@ -67,14 +67,12 @@ The following translations are currently maintained by the project:
We are certainly not limited to the above. If you are willing and able to translate RaspAP in your language, you will be credited as the original translator (see below).
### Contributing a translation
The process is very straightforward. Start by downloading [this Portable Object file](https://raw.githubusercontent.com/billz/raspap-webgui/master/locale/en_US/LC_MESSAGES/messages.po) and replace the `msgstr` messages with your translations. For example, an original English `msgid` and the French `msgstr` translation is below:
## Contributing a translation
RaspAP now has a translation [project home at Crowdin](https://crowdin.com/project/raspap). This is the place to go for all volunteers who would like to contribute to our ongoing translation efforts. If you'd like to be among the volunteers who help translate RaspAP, please read the following.
```
msgid "Dashboard"
msgstr "Tableau de bord"
```
### How to become a translator
If you want to join RaspAP's translators, start by signing up for a free account at [Crowdin](https://crowdin.com/).
Please be sure to include accent characters, if applicable. Email the translated .po files back to [@billz](https://github.com/billz/) (email address is in the .po file). We will compile them into Machine Object (.mo) files and add them to the project. Contributors will be credited as the original translators.
![Crowdin](https://i.imgur.com/578Yv4P.png)
Many thanks.
Once you are logged in, head over to our [project home](https://crowdin.com/project/raspap). Here you will find our supported translations, recent activity, discussions and so on. You can get started by simply choosing the language you'd like to contribute to. For more info, see Crowdin's [detailed walkthrough](https://support.crowdin.com/crowdin-intro/#translation-process) of the translation process.