83 Commits

Author SHA1 Message Date
MohitMaliFtechiz
6cae44821e Refactored RxJava to coroutines in ConnectivityBroadcastReceiver.
* Simplified the `combineToLanguageList` method and removed warnings.
* Refactored `ZimManageViewModelTest` to align with the changes.
* Removed unused `RxJava` code from the project.
* Removed all `RxJava` dependencies from the project.
* Updated the `README` file to reflect that `RxJava` is no longer used.
* Updated `credit.html` accordingly, similar to the `README`.
2025-05-27 17:48:28 +05:30
tepozoa
c9717655cc update IzzySoft package URL 2025-04-25 09:11:23 -05:00
MohitMaliFtechiz
683392c3cc Updated the README file to reflect the compatible version of Android Studio.
* Since there's no official Android Studio IDE that supports Android 16 yet — it's currently in the final beta phase and is expected to launch in May or possibly June — we need to use the `Canary build` of the `Narwhal` version for now. Therefore, we're updating the README file accordingly. Once the official IDE is released, we'll update the README again.
2025-04-19 17:36:26 +02:00
MohitMaliFtechiz
53e6cf3f92 Fixed: After upgrading Gradle, we were unable to upload the AAB because APK splitting was enabled.
* ABI splitting is now enabled only when needed (i.e., when building an APK) through an environment variable (APK_BUILD). By default, ABI splitting remains disabled.
* Refactored the workflow to align with this change.
* Updated the README to document this change, ensuring that everyone is aware of this feature.
2025-04-03 15:14:07 +05:30
MohitMaliFtechiz
5b7a3af657 Minor improvement in showing the directory path in README file. 2025-02-05 15:49:55 +05:30
Anu
3a8bde4c38 Update README.md
Added emojis, clarified wording, etc.
2025-02-01 12:12:55 +01:00
Emmanuel Engelhart
aedfb8dae8
Light simplification 2025-01-19 16:18:59 +01:00
MohitMaliFtechiz
1f322aa1f9 Added a section in the README file to showcase the two variants of our application.
* It explains why we introduced two variants, highlights the differences between them, and provides guidance on how users can transfer their content from the previous app to the new app.
2025-01-19 15:52:31 +01:00
MohitMaliFtechiz
66f3d4d7cd Refactored all CD pipelines to generate APKs and app bundles based on the relevant git revision.
* The date is extracted from the specified git revision and set in the `KIWIX_ANDROID_RELEASE_DATE` environment variable, and the version code is generated for that date.
* This feature has been added to the Release section in the README file.
2025-01-04 12:24:26 +05:30
MohitMaliFtechiz
40285a7cfd Documented this new feature in the README.md file so that this feature can be easily used. 2025-01-04 10:02:19 +05:30
Emmanuel Engelhart
7313a12005
Rephrase a bit the README 2025-01-01 14:41:25 +01:00
MohitMaliFtechiz
b2e42748b4 Updated the outdated content of the README file. As now we have the file picker functionality in our PS variant, and README was showing that there is no file picker in PS variant. 2025-01-01 14:08:40 +01:00
MohitMaliFtechiz
91a382a39a Added the information about permissions used in the application in the README file to show users why and where we are using these permissions. 2025-01-01 14:08:40 +01:00
MohitMaliFtechiz
ad28e09392 Added fetch library in credits.html, and README.md files. 2024-12-19 11:43:51 +05:30
MohitMaliFtechiz
bfd9e57c12 Removed the `ButterKnife ' from the README file as we are not using this library in our project anymore.
* Also removed this library from the `credits.html` of both the app and custom modules.
2024-12-11 18:03:34 +05:30
MohitMaliFtechiz
bf84774ba9 Added IzzyOnDroid badge and link in README file instead of F-droid badge and link 2024-11-21 10:25:08 +01:00
MohitMaliFtechiz
b74e084f99 Fixed: storage spelling was incorrect in the possible paths table for the Play Store variant in the README file 2024-11-14 13:43:16 +01:00
MohitMaliFtechiz
903c1e142e Corrected all the messages related to ZIM, and improved the message of copy/move ZIM file dialog 2024-11-12 18:59:00 +05:30
MohitMaliFtechiz
3f7d0f7214 Updated the testing_release.yml to use the JAVA 17.
* Updated the README file to show that now our project requires the JAVA 17 instead of JAVA 11.
* Updated the pre-commit failed message to properly show the error information.
2024-08-16 15:35:10 +00:00
MohitMaliFtechiz
c9b43117e6 Removed the fetch library from README file.
* Also, now we are not using fetch library anymore so we have removed this from our credits files.
* Removed the unused code from detekt_baseline.xml file.
2024-08-12 17:15:42 +05:30
MohitMaliFtechiz
706c47ae6a Updated the README file to show all possible paths which are supported by the play store version for scanning/reading zim files. 2024-08-08 17:00:06 +05:30
MohitMaliFtechiz
34618aec05 Fixed: Download zim files in Android/media/org.kiwix/kiwixmobile/ folder instead of internal app-specific directory.
* Now all the downloading files will store in this public app-specific directory.
* Refactored the code to show this new location in storageSelection dialog for both internal and external storage.
* Updated the `README.md` file to educate user that how they can read already downloaded zim files in PS version.
* Refactored the test cases according to this change.
2024-08-08 16:57:31 +05:30
Shaun Burch
3c8f5a44e9 #1553 Generate & show QR 2024-07-01 22:01:53 -04:00
MohitMaliFtechiz
34928323d5 Updated minimum SDK version to 25.
* Updated the `README.md` file for this new change.
* Removed the API level 24 from CI and added the API level 25 since now our minimum SDK version is 25.
* Renamed CompatV24 file since we have upgraded the minimum SDK version so this fileName was irrelevant.
2024-05-13 13:03:21 +05:30
Emmanuel Engelhart
59531677d5
Small refresh of the README.md 2024-04-13 15:24:28 +02:00
MohitMaliFtechiz
45be2860bb Added information about JDK configuration to the README file.
* Our project requires `Java 11` to run. Therefore, developers should set the `Gradle JDK` to `Java 11`. We have included this information in the `Build Instructions` section of the `README` file.
2024-04-04 07:16:03 +02:00
MohitMaliFtechiz
4da3922a18 Updated badges and documentation.
* Fixed the badging of `Build Status` and `Codecov`.
* Since there is no `master` and `develop` branches, we have updated our `CONTRIBUTING.md` to reflect these changes.
2024-01-05 19:37:07 +05:30
MohitMaliFtechiz
f2ef85c363 Fixed: Links to Config.kt and CONTRIBUTING.md were not functioning in the README.md file.
* As we've renamed the default branch from 'develop' to 'main,' we have accordingly updated the links.
2023-12-27 16:19:44 +01:00
JJ
1a58589633
Update README.md
Fixed a very small spelling error.
2023-10-04 01:32:32 -07:00
Emmanuel Engelhart
644521c722 Add library dependence libkiiwx to the README 2023-09-18 19:13:20 +02:00
MohitMali
f7517a2272 Minimum SDK version changed to 24: The NDK version in kiwix-build has been upgraded (as mentioned in https://github.com/kiwix/kiwix-build/issues/544). However, to make this upgrade compatible, the minimum SDK version had to be updated to 24 since the NDK version is not compatible with Android API levels below 24. The README.md file has been updated to reflect the new minimum Android support version, which is now Android 7, due to the change in the minimum SDK version. Since the project's minimum SDK version is now 24, some conditions related to Android 23 and 24 have become unused. These unused conditions have been removed, and along with that, the drawable-night-23 and drawable-23 launch_screen.xml files, which were no longer in use, have also been removed. 2023-09-18 19:13:20 +02:00
Emmanuel Engelhart
c1c1cac1ee
Few rewrittings 2023-08-17 11:30:10 +08:00
MohitMaliFtechiz
416edddb9a
Updated README.md file to explain ZIM File Picker Restriction and Storage Scanning in play store variant 2023-08-17 11:21:16 +08:00
MohitMaliFtechiz
2e4bb76cec Fixes of Better communication about min/max SDK/Android version supported 2023-06-01 16:56:52 +02:00
Emmanuel Engelhart
46a5fd43bb
Polishing of localisation documentation 2023-05-09 08:08:01 +02:00
MohitMaliFtechiz
4306491ae7
Merged STRING_RESOURCES.md with README.md 2023-05-09 07:47:51 +02:00
MohitMaliFtechiz
005c134e78
Added localization instructions in the README.md file 2023-05-09 07:47:50 +02:00
Kelson
63a3995ce1
Proper CI Badge 2023-01-09 17:23:24 +01:00
Kelson
76bca0547a
Kiwix for Android is 100% Kotlin now 2023-01-08 15:45:40 +01:00
Kelson
0fa22b7027
Better (dark-mode friendly) Kiwix Logo 2023-01-08 15:44:57 +01:00
Alistair Findlay
eb4f35d657
Fixed grammar 2022-07-13 15:48:48 +10:00
Popo le Chien
91a999f3b9
Update README.md
Updated logo / fixed link
2022-05-23 16:56:13 +02:00
Popo le Chien
f944f35df6
Update README.md
updated expired Slack invitation link
2022-05-23 16:52:33 +02:00
Dhiraj Chauhan
a58cf14630
added NIghtly Badge beside CI 2021-12-04 17:54:08 +05:30
Dhiraj Chauhan
63c19e412b
#2636 Added Nightly Status Badge in Readme 2021-12-04 17:24:57 +05:30
hitesh kuber
7a36095520
updated README.md
typos removed
2020-05-27 00:50:39 +05:30
Yash Khare
56d61a7949
Fix #1794 Improve README instructions about project import 2020-02-25 11:33:49 +05:30
Abdul Wadood
679b75d009
Update README.md
Add slack workspace & invite links.
2020-02-24 18:07:42 +05:30
deborahlow97
fd38ec077a Update README with slack details 2020-02-24 18:42:26 +08:00
Kelson
9dffcc9a6b
Small imp. in the README 2020-02-05 12:51:19 +01:00