Skip to content

Commit 2390be3

Browse files
authored
Translation Guidelines for CachyOS-Welcome README.md
1 parent 2b42d47 commit 2390be3

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,33 @@
1111

1212
</p>
1313
</div>
14+
15+
## Translation Guidelines for CachyOS-Welcome
16+
17+
We are always open to community members adding new translations. This helps immensely for non-English speakers.
18+
19+
### Directory Structure in `i18n`
20+
21+
```md
22+
CachyOS-Welcome/i18n/en # Main English directory with all original text.
23+
CachyOS-Welcome/i18n/de # German translation directory.
24+
CachyOS-Welcome/i18n/cs # Czech translation directory.
25+
CachyOS-Welcome/i18n/_your_language_code # Directory for your language translation.
26+
```
27+
28+
### Steps for Adding a Translation
29+
30+
1. **Determine Your Language Code**
31+
Refer to the [ISO 639-1 list of language codes](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes#Table) to find the proper code for your language.
32+
33+
2. **Locate the `i18n` Directory**
34+
This directory, available in the repository, contains all existing translations.
35+
36+
3. **Create a Directory for Your Language**
37+
Use the code of your language (e.g., `fr` for French, `es` for Spanish) as the directory name.
38+
39+
4. **Use the English Files as Templates**
40+
Copy the files from `CachyOS-Welcome/i18n/en` to your newly created directory. Translate the content from **English** into **your language**, ensuring the translations are meaningful and accurate.
41+
42+
5. **Submit a Pull Request (PR)**
43+
Once your translations are complete, submit a Pull Request (PR) to the repository. This allows us to review and merge your contribution.

0 commit comments

Comments
 (0)