diff --git a/README.md b/README.md index 46e4943d52005d1a3c774ee5f668df2152e3b590..ccf9aab5774521910e67f2b43ad639c0b3836423 100644 --- a/README.md +++ b/README.md @@ -50,6 +50,23 @@ If you encounter something like leave the `{{name}}` part alone and do not translate it. "name" is not part of the text and will be replaced by the appropriate value when the app runs. +### Translating an update + +From time to time, we'll add new strings to all the language files. The new strings will be in English and ready to be translated to your language of choice. + +Update commits usually have message in the format of "Update strings for 1.x.x" where "1.x.x" is the new version number. This is an example commit: [Update strings for 1.2.7](https://github.com/obsidianmd/obsidian-translations/commit/8bff16a8b866604876d417bf7f322484b6090431). + +By examining what happened to your language file, you can find the new strings to translate. + +### Translate a missing phrase on the UI + +If you spot a missing phrase while using Obsidian, here's what to do: + +1. Figure out where the language file lives by looking up the language table in the README under the ["Existing languages" section](https://github.com/obsidianmd/obsidian-translations#existing-languages). +2. Edit the language file, look for the exact English phrase. +3. Replace it with the appropriate translated phrase. +4. Submit your changs as a pull request. + ## Existing languages Here is a table of language code to language name, in alphabetical order. These languages have their template files ready, but are not necessarily ready to be used in the app. @@ -103,6 +120,7 @@ Here is a table of language code to language name, in alphabetical order. These | `tr` | Turkish | Türkçe | ✅ | | `uk` | Ukrainian | УкраїнÑька | 🚧 | | `ur` | Urdu | اردو | 🚧 | +| `vi` | Vietnamese | Tiếng Việt | ✅ | | `zh` (see note below) | Chinese (Simplified) | 简体ä¸æ–‡ | ✅ | | `zh-TW` | Chinese (Traditional) | ç¹é«”ä¸æ–‡ | ✅ |