Skip to content

Commit

Permalink
Merge pull request #720 from aitor/master
Browse files Browse the repository at this point in the history
Definition and example configuration of translation process
  • Loading branch information
glouel authored Feb 13, 2019
2 parents 1be43b6 + d27ab0b commit b0d200e
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
lokalise.cfg
.DS_Store
xcuserdata/
compile/
Expand Down
29 changes: 29 additions & 0 deletions Resources/Community/Readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Translations of the community strings

Aerial features overlay descriptions of the main geographical features displayed in its videos. This is possible thanks to the collaboration and uninterested work of many. To best serve this international community we've a translation workflow defined that allows any person, even with no technical background to help translating the descriptions.

In the following sections we explain how to collaborate in the internationalization process both as a translator and as a developer.

## For translators

1. Contact @glouel or @aitor to get added to the Translators team at Lokalise.
2. Access the translations dashboard at https://lokalise.co/ and translate or update the existing strings to your language.
3. PROFIT!

## For developers

The translation workflow follows a pull mode, meaning that new strings will be defined in the Lokalise service and pulled into the project once they have been translated. The pulling process will be repeated after any changes has been made to the strings.

### Setting up the project

1. Contact @glouel to get added to the Devs team at Lokalise.
2. Use the existing configuration example file to create your local configuration
`cp lokalise.example.cfg lokalise.cfg`
3. In the created file update the `Token` string with your token. To get your token visit the section `API Tokens` at https://lokalise.co/profile

### Downloading/pulling translations

1. Install Lokalise CLI: https://docs.lokalise.co/api-and-cli/lokalise-cli-tool
2. Once the CLI has been installed you can pull the latest versions of each language with the following command:
`lokalise --config lokalise.cfg d --type json --dest Resources/Community --unzip_to Resources/Community`
3. Commit and push the new `*.json` files to the repo.
2 changes: 2 additions & 0 deletions lokalise.example.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Token = "YOUR_LOKALISE_TOKEN"
Project = "526621525c59d35a304987.58424707"

0 comments on commit b0d200e

Please sign in to comment.