Skip to content

Commit e5fe64d

Browse files
committed
Update README
1 parent 006e00a commit e5fe64d

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,41 @@ These text documents contain translations for [OpenOMF],
66
a remake of One Must Fall 2097.
77

88
[OpenOMF]: https://github.com/omf2097/openomf
9+
[openomf sourcecode repo]: https://github.com/omf2097/openomf
10+
11+
12+
Current Status
13+
--------------
14+
15+
[ENGLISH.TXT](ENGLISH.TXT): Complete.
16+
[GERMAN.TXT](GERMAN.TXT): Mostly complete, but has no maintainer and a few strings in English.
17+
[DANISH.TXT](DANISH.TXT): Low quality, low effort, machine translation.
18+
19+
20+
Translators Guide
21+
-----------------
22+
23+
TODO: Write a guide on how to contribute a translation.
24+
25+
TLDR; copy ENGLISH.TXT, make your changes, and open a pull request.
26+
27+
28+
Programmers Guide
29+
-----------------
30+
Note that this repo is included in openomf as a submodule.
31+
32+
To add a language string to this repo:
33+
- Add the new language string to each language TXT in this repo.
34+
Using English as a placeholder is fine, so long as you leave a comment
35+
`# TODO: Translate ...`
36+
- Update the [`langstr_count` file] with the new number, so the CI pipeline can pass.
37+
- Open a pull request to this repo with the above changes.
38+
39+
[`langstr_count` file]: langstr_count
40+
41+
To add a language string to the [openomf sourcecode repo]:
42+
- Add the translation to [`LanguageStrings.cmake`]
43+
- Update the [`translations` submodule], with required modifications described above.
44+
45+
[`LanguageStrings.cmake`]: https://github.com/omf2097/openomf/blob/master/cmake-scripts/LanguageStrings.cmake
46+
[`translations` submodule]: https://github.com/omf2097/openomf/blob/master/resources

0 commit comments

Comments
 (0)