Skip to content

Commit

Permalink
Add readme for localization data
Browse files Browse the repository at this point in the history
Arduino IDE has been translated to several languages.

The localization process follows the following steps:

1. An English language source string is defined in the Arduino IDE codebase
2. The source string is pushed to Transifex
3. Community translators localize the string
4. The localization data is pulled into the Arduino IDE repository
5. The localization data is incorporated into the Arduino IDE distribution

Experience with maintenance of Arduino's localized projects indicates that the data files generated at step (4) can
appear to be the appropriate place to make edits for casual contributors not familiar with the project's sophisticated
internationalization infrastructure.

Since those files are generated by automated systems, any edits made there would only be overwritten, so it is important
to clearly communicate the correct way to make enhancements or corrections to these strings. This is accomplished by a
local readme file most likely to be seen by those working in the folder containing these files, which supplements the
existing information about translation in the project's translation guide.
  • Loading branch information
per1234 committed Sep 26, 2022
1 parent 5eb2926 commit 8380c82
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions i18n/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Localization Data

This folder contains the [localization](https://en.wikipedia.org/wiki/Internationalization_and_localization) data for Arduino IDE.

❗ These files are automatically generated and so can not be edited directly. If you wish to modify the contents, do it at the source:

- **en.json** - edit the string in [the source code](../arduino-ide-extension/src)
- **All other files** - the localization is done on **Transifex**:<br />
https://explore.transifex.com/arduino-1/ide2/

For more information on translating Arduino IDE, see [the **Translator Guide**](../docs/contributor-guide/translation.md).

0 comments on commit 8380c82

Please sign in to comment.