Skip to content

Commit

Permalink
update locale guide
Browse files Browse the repository at this point in the history
  • Loading branch information
spessasus committed Oct 31, 2024
1 parent 4ae7071 commit 098bc78
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions src/website/js/locale/locale_files/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,24 @@ I welcome contributions from translators! To add a new locale, please follow the
- Translate all the strings in the `locale.js` file and all `.js` files in the folders. Make sure to leave the
object keys unchanged.
- You may add comments to indicate who translated the text, e.g., `// translated by: XYZ`.

5. **Update `locale_list.js`**
- **Note:** Strings containing placeholders, like `Channel {0}`, should keep the placeholders intact. They are used for
formatting and should not be altered.
- **Note 2:** The code sets `textContent` property, so doing HTML characters like `<`
is not needed.
For new line, use `\n`

5. **Verify your work**
- [Minify the website](../../../../README#app)
- Change the language to the translated language.
- Test your changes in the Local Edition!
- Remember to hover over various controls to see the translated descriptions.

6. **Update `locale_list.js`**
- Open `locale_list.js`.
- Add a new entry for your locale. For example, for German, add: `"de": localeGerman,`.

6. **Submit a Pull Request**
7. **Submit a Pull Request**
- After completing the translation and updates, create a pull request with your changes. Thank you for helping
SpessaSynth!

*If you have any questions about this guide or something is unclear, let me know by opening an issue!*

<!--don't use github !NOTE here as people might open this README in a text editor-->
**Note:** Strings containing placeholders, like `Channel {0}`, should keep the placeholders intact. They are used for
formatting and should not be altered.

**Note 2:** The code sets `textContent` property, so doing HTMl characters like `&lt;`
is not needed.
For new line, use `\n`

0 comments on commit 098bc78

Please sign in to comment.