Merge pull request #5 from montylion/master

Add localization guide, minor changes
This commit is contained in:
Jonathan Barrow 2021-09-12 12:09:29 -04:00 committed by GitHub
commit a10dd96e28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 43 additions and 3 deletions

View file

@ -18,6 +18,10 @@ The following is a guide designed to help new developers get a feel for how best
* [Getting started](#getting-started)
* [Contributing to PRUDP, NEX, or services](#contributing-to-prudp-nex-or-services)
[Localization](#localization)
* [Localization guidelines](#localization-guidelines)
* [Localizing the website](#localizing-the-website)
## Code of Conduct
This project and everyone participating in it is governed by the [Pretendo Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
@ -110,6 +114,42 @@ if (oSession.HostnameIs("account.nintendo.net"))
If using Cemu, follow the [Cemu online play guide](http://compat.cemu.info/wiki/Tutorial:Online_Play) to get Cemu online. Then modify the above steps to work with Cemu (untested).
## Localization
### Localization guidelines
- Meaning is more important than a 1:1 translation! If a sentence sounds weird in your language, you are not only allowed, but advised to change that to sound better, as long as it keeps the original meaning.
- If you aren't sure about a translation for a word or idiom, ask in the [#localization channel in the Discord server](https://discord.gg/egYeXEvzYv): someone who speaks your language might be able to help you.
### Localizing the website
At the time of writing the only part of the project ready to be localized is the [main website](https://www.pretendo.network).
To localize the website, translate the contents of the [`US_en.json`](https://github.com/PretendoNetwork/website/blob/dev/locales/US_en.json) file from `/locales` into a file named REGION_language.json (e.g. `UK_en.json`, `IT_it.json`, `DE_de.json`, etc.).
Make sure to translate the strings from the working branch ([dev](https://github.com/PretendoNetwork/website/tree/dev)) and not the release branch ([master](https://github.com/PretendoNetwork/website/tree/master)), as the ones in the master branch are likely to be outdated.
When you're translating the json file, make sure to only edit the correct strings!
This example snippet should give you a general idea of what to edit:
```JSON
{
"faq": {
"title": "Edit this text",
"text": "Edit this text",
"QAs": [
{
"question": "Edit this text",
"answer": "Edit this text"
}
]
}
}
```
You should keep proper names or links unchanged.
You can then test your json file [here](https://pretendo.network/localization).
## Attribution
This contributing guideline is adapted from the [Atom contributing guideline](https://github.com/atom/atom/blob/master/CONTRIBUTING.md).
This contributing guideline is adapted from the [Atom contributing guideline](https://github.com/atom/atom/blob/master/CONTRIBUTING.md).

View file

@ -14,11 +14,11 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduc
## Goals/Roadmap
Pretendo is a large project with many smaller sections, each with their own goals. To find the goals and roadmap for a specific section of the network, check it's repo.
Pretendo is a large project with many smaller sections, each with their own goals. To find the goals and roadmap for a specific section of the network, check its repo.
# Service repositories:
- NEX framework [https://github.com/PretendoNetwork/nex-go](https://github.com/PretendoNetwork/nex-go)
- account server [https://github.com/PretendoNetwork/account](https://github.com/PretendoNetwork/account)
- Account server [https://github.com/PretendoNetwork/account](https://github.com/PretendoNetwork/account)
- eShop (PoC) [https://github.com/PretendoNetwork/eShop](https://github.com/PretendoNetwork/eShop)
# Non-service repositories: