Skip to content

Commit 9fe8560

Browse files
authored
[skip changelog] Add readme for localization data (#1837)
Arduino CLI has been translated to 12 languages. The localization process follows the following steps: 1. An English language source string is defined in the Arduino CLI codebase 2. The source string is pushed to Transifex 3. Community translators localize the string 4. The localization data is pulled into the Arduino CLI repository 5. The localization data is incorporated into the Arduino CLI distribution Experience with maintenance of the Arduino IDE 1.x project 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 CONTRIBUTING.md.
1 parent c756472 commit 9fe8560

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

i18n/data/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Localization data
2+
3+
This folder contains the [localization](https://wikipedia.org/wiki/Language_localisation) data for **Arduino CLI**.
4+
5+
❗ These files are automatically generated and so can not be edited directly. If you wish to modify the contents, do it
6+
at the source:
7+
8+
- **en.po** - edit the string in the source code file indicated by the comment above it <br /> e.g., a comment
9+
`#: commands/upload/upload.go:615` indicates the source string is at line 615 of the file
10+
[`commands/upload/upload.go`](../../commands/upload/upload.go)
11+
- **All other files** - the localization is done on **Transifex**: <br />
12+
https://explore.transifex.com/arduino-1/arduino-cli/

0 commit comments

Comments
 (0)