kiwix/kiwix-apple-custom
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-apple-custom.git synced 2025-08-03 18:46:07 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Co-authored-by: rgaudin <reg@rskg.org>
This commit is contained in:
BPH 2024-01-15 17:07:44 +01:00 committed by GitHub
parent a071d0b306
commit ce2b057a5b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -28,7 +28,7 @@ important fields are:
- `about_app_url` - this is an external link that is placed in the "About section" of the application. (Eg. "https://www.dwds.de")
- `about_text` - this is a custom text that is placed in the "About section" describing what the application is about.
- `app_name` - the title of the app
- `app_store_id` - this should to be taken from the developer.apple.com, where the application release is prepared. Note you can take use the app_store_id even if the app is not yet released. The id is used within the app in the "Rate the app" section, so users can be redirected to a specific app in the App Store, to rate it.
- `app_store_id` - this should to be taken from the developer.apple.com, where the application release is prepared. Note you can use the app_store_id even if the app is not yet released. The id is used within the app in the "Rate the app" section, so users can be redirected to a specific app in the App Store, to rate it.
- `build_version` - it should be a single digit number, used as the last part of the final app version.
[MAJOR].[MINOR].**[PATCH]**. The final version of the app contains the date of the ZIM file provided (using the year and month) and the build_version as the last part. The format of the version comes from the [Apple docs](https://developer.apple.com/documentation/bundleresources/information_property_list/cfbundleshortversionstring). Eg., given a ZIM file: "dictionary_nopic_2023-12-15.zim", and "build_version": "5" we combine it the following way: take the year 2023 and the month 12 from the ZIM file, and combine it with the build_version, resulting in: "2023.12.5". [More on this process here](https://github.com/kiwix/apple/issues/559).
- `enforced_lang` - (lang code eg: en, de, he) if it is set, it will include only this language in the final app, meaning no other languages can be selected (on iOS) for the application UI. See the current list of supported languages [already translated in the main repo](https://github.com/kiwix/apple/tree/main/Support). When using this option, make sure that [the translation coverage](https://translatewiki.net/wiki/Special:MessageGroupStats/kiwix-apple?group=kiwix-apple&messages=&suppressempty=1&x=D) is 100% for the enforced language.