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

Small refresh of the README.md

Browse Source
This commit is contained in:
Emmanuel Engelhart 2024-04-13 15:22:17 +02:00
parent 5e3a5661e0
commit 59531677d5
No known key found for this signature in database
GPG Key ID: 120B30D020B553D3
1 changed files with 32 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@ -9,27 +9,28 @@
# Kiwix Android # Kiwix Android
Kiwix is an offline reader for Web content. One of its main purposes Kiwix is an offline reader for Web content. One of its main purposes
is to make Wikipedia available offline. This is done by reading the is to make [Wikipedia](https://www.wikipedia.org/) available
content of a file in the ZIM format, a highly compressed open format offline. This is achieved by reading the content of a file in the
[ZIM](https://openzim.org) format, a highly compressed open format
with additional metadata. with additional metadata.
This is the version for Android, with support versions ranging from 7 This is the version for Android, with [support versions ranging from 7
to 13 (like [mentioned to 13](https://github.com/kiwix/kiwix-android/blob/main/buildSrc/src/main/kotlin/Config.kt).
here](https://github.com/kiwix/kiwix-android/blob/main/buildSrc/src/main/kotlin/Config.kt)).
**Important Note**: Starting from Android 11, the ZIM file picker **Important Note**: Starting from Android 11, the ZIM file picker
feature has been restricted in the Play Store variant due to Play feature has been restricted in the [Play Store
Store policies. This means that users running Android 11 and above variant](https://play.google.com/store/apps/details?id=org.kiwix.kiwixmobile)
will not be able to load ZIM files from internal/external storage due to Play Store policies. This means that users running Android 11
directly within the app if they have downloaded Kiwix from the Google and above will not be able to load ZIM files from internal/external
Play Store. This restriction is in place to comply with the Play storage directly within the app if they have downloaded Kiwix from the
Store policies. The Play Store variant of Kiwix does not require the Google Play Store. This restriction is in place to comply with the
`MANAGE_EXTERNAL_STORAGE` permission anymore, which is necessary to Play Store policies. The Play Store variant of Kiwix does not require
scan storage and access ZIM files at arbitrary locations. Therefore, the `MANAGE_EXTERNAL_STORAGE` permission anymore, which is necessary
the storage scanning & file picking functionalities are not available to scan storage and access ZIM files at arbitrary locations.
in this variant anymore. To use the full version of Kiwix and benefit Therefore, the storage scanning & file picking functionalities are not
of the ZIM file picker feature, you can download it directly from the available in this variant anymore. To use the full version of Kiwix
[official and benefit of the ZIM file picker feature, you can download it
directly from the [official
repository](https://download.kiwix.org/release/kiwix-android/) or use repository](https://download.kiwix.org/release/kiwix-android/) or use
[F-Droid](https://fdroid.kiwix.org). We understand that this [F-Droid](https://fdroid.kiwix.org). We understand that this
restriction may cause inconvenience, but it is necessary to comply restriction may cause inconvenience, but it is necessary to comply
@ -47,19 +48,22 @@ Kiwix Android is written in [Kotlin](https://kotlinlang.org/)
[![Public Chat](https://img.shields.io/badge/public-chat-green)](https://chat.kiwix.org) [![Public Chat](https://img.shields.io/badge/public-chat-green)](https://chat.kiwix.org)
[![Slack](https://img.shields.io/badge/Slack-chat-E01E5A)](https://kiwixoffline.slack.com) [![Slack](https://img.shields.io/badge/Slack-chat-E01E5A)](https://kiwixoffline.slack.com)
## Build Instructions ## Build instructions
Production releases of the app are built on travis and released automatically To build Kiwix Android, clone [this
repository](https://github.com/kiwix/kiwix-android) and import (not
open) the project with [Android
Studio](https://developer.android.com/studio).
To build this repository alone for development purposes you can simply If you prefer to build without Android Studio you must first set up
**import** the project into Android Studio and the hard work will be done the Android SDK and then run the command: `./gradlew build ` from the
for you. Note here that instead of *opening* the project, you have to *import* it. If you prefer to build without Android Studio you must first root directory of the project. The project requires `Java 11` to run,
set up the Android SDK and then run the command: `./gradlew build ` Therefore set the `Gradle JDK` to `Java 11`.
from the root directory of the project. The project requires `Java 11` to run, Therefore set the `Gradle JDK` to `Java 11`.
Kiwix-Android is a multi-module project, in 99% of scenarios you will want to build the `app` module in the `debug` configuration. Kiwix Android is a multi-module project, in 99% of scenarios you will
If you are interested in our custom apps they have their own repo [kiwix-android-custom](https://github.com/kiwix/kiwix-android-custom want to build the `app` module in the `debug` configuration. If you
) that goes into further detail are interested in our custom apps, they have their own repo
[kiwix-android-custom](https://github.com/kiwix/kiwix-android-custom).
## Libraries Used ## Libraries Used
@ -82,18 +86,15 @@ Before contributing be sure to check out the
[CONTRIBUTION](https://github.com/kiwix/kiwix-android/blob/main/CONTRIBUTING.md) [CONTRIBUTION](https://github.com/kiwix/kiwix-android/blob/main/CONTRIBUTING.md)
guidelines. guidelines.
We currently have a series of automated Unit and Integration We currently have a series of automated Unit & Integration
tests. These can be run locally and are also run when submitting a tests. These can be run locally and are also run when submitting a
pull request. pull request.
## Communication ## Communication
Available communication channels: Available communication channels:
* [Web Public Chat channel](https://chat.kiwix.org)
* [Email](mailto:contact+android@kiwix.org) * [Email](mailto:contact+android@kiwix.org)
* [Mailing list](mailto:kiwix-developer@lists.sourceforge.net)
* [Slack](https://kiwixoffline.slack.com): #android channel [Get an invite](https://join.slack.com/t/kiwixoffline/shared_invite/zt-19s7tsi68-xlgHdmDr5c6MJ7uFmJuBkg) * [Slack](https://kiwixoffline.slack.com): #android channel [Get an invite](https://join.slack.com/t/kiwixoffline/shared_invite/zt-19s7tsi68-xlgHdmDr5c6MJ7uFmJuBkg)
* IRC: #kiwix on irc.freenode.net
For more information, please refer to For more information, please refer to
[https://wiki.kiwix.org/wiki/Communication](https://wiki.kiwix.org/wiki/Communication). [https://wiki.kiwix.org/wiki/Communication](https://wiki.kiwix.org/wiki/Communication).