diff --git a/README.md b/README.md index 5719832..15de32d 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,27 @@ It is completely static other than the 8 php scripts licensed under a GNU Affero To start a version locally, you can use https://github.com/danvk/ssi-server or nginx configs similar to vern/nginx-configs:/common/website.conf. + +# Translating + +You want to help ~vern and are fluent in English and another language? Great! + +Follow these steps to start translating our website. For finer details, check out the existing pt-BR translation. + +1. Sign in (Preferrably with ~vern, if you have an account, but Codeberg OAuth2 is fine) +2. Fork this repo +3. Copy en/ to the code of whatever language you want to translate it into (we'll call it xx from now on) +4. Remove xx/translations.php +5. Translate! (but not xx/tos.html, xx/privpol.html, xx/p/list.php, or anything that isn't shown to the user (i.e. E-mails sent to admins)) +6. Create xx/tl-notice.html that looks something like this, but in your language: +```html +

Translation notice

+

The following document is written in english because of ~vern's geographical jurisdiction. Taking into account that all our servers are in the USA or Canada, the following text couldn't be translated. Currently, our translators can't find a viable way of translating the document whilst keeping the same legal meaning. If you have any suggestions, contact an admin.

+

With this stance, here's the original document, in English:

+``` +6. Add the following text in tos.html and privpol.html directly under the nav.php include. +```html + +``` +7. Add your language to en/translations.php +8. Create a pull request