diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e8caa7cb0..b0c5fd14d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,10 +58,6 @@ If you wish to rebase you should be following the [Golden Rule](https://www.atla For an overview of how to make design changes to Kiwix Android, check out [DESIGN.md](https://github.com/kiwix/kiwix-android/blob/develop/DESIGN.md). -### Adding new string resources - -To add a new string resource see [STRING_RESOURCES.md](https://github.com/kiwix/kiwix-android/blob/develop/STRING_RESOURCES.md). - ### Building The Kiwix app is split into 3 modules diff --git a/README.md b/README.md index 9e32037dc..5827bfa9b 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,30 @@ guidelines. Pull requests not matching the style will be rejected. Kiwix Android is available in multiple languages and managed by Translatewiki. When adding new string resources, contributors are required to provide additional context on how and where the new string will be used. This helps translators to understand the context and translate accurately. -Before adding new string resources, please read the [STRING_RESOURCES](https://github.com/kiwix/kiwix-android/blob/develop/STRING_RESOURCES.md) carefully. + +### String resources +All user visible strings in an Android application should be listed in strings.xml files to allow for easy translation, replacement and modification. +Newly added string resources are imported by translatewiki and are then manually translated. +After translations are complete the translations are merged with Kiwix Android. + +#### How do I add a new string resource? +Start by adding your new string resource `new_string` to `values/strings.xml` in English. That is: +``` +... +New String +... +``` +You will now have to describe the string in `values-qq/strings.xml` with where and how the new string is used. E.x. for the string `On`: + +`values-qq/strings.xml:` +``` +... +This is used in the settings screen to turn on the night mode. +... +``` +- The values in `values/strings.xml` are the strings that are going to be displayed in the Kiwix application to the user. +- The values in `values-qq/strings.xml` are only visible to the translator and are only there to help them make a correct translation. + ## Communication diff --git a/STRING_RESOURCES.md b/STRING_RESOURCES.md deleted file mode 100644 index d6fead918..000000000 --- a/STRING_RESOURCES.md +++ /dev/null @@ -1,20 +0,0 @@ -# String resources -All user visible strings in an Android application should be listed in strings.xml files to allow for easy translation, replacement and modification. Newly added string resources are imported by translatewiki and are then manually translated. After translations are complete the translations are merged with Kiwix Android. - -## How do I add a new string resource? -Start by adding your new string resource `new_string` to `values/strings.xml` in English. That is: -``` -... -New String -... -``` -You will now have to describe the string in `values-qq/strings.xml` with where and how the new string is used. E.x. for the string `On`: - -`values-qq/strings.xml:` -``` -... -This is used in the settings screen to turn on the night mode. -... -``` -- The values in `values/strings.xml` are the strings that are going to be displayed in the Kiwix application to the user. -- The values in `values-qq/strings.xml` are only visible to the translator and are only there to help them make a correct translation.