kiwix/kiwix-js-pwa
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-js-pwa.git synced 2025-09-13 06:22:09 -04:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Former-commit-id: 33c5abfcefafa16349227db9d6846af392923840 [formerly 9ebef79f9389e86b8efef7d64433cc3a2931f36d] [formerly 5a04baeef47831bcab339bc4fbc652ed03cfa26e] [formerly 7ff7b553a3ab5995da8136a969758fd9668159dc [formerly b7b7c75f7ed0f9fb7fc52313886791c1c0708d8a [formerly 8947a695969380ee3a06e996dafbddb5588f0c13]]]
Former-commit-id: f4ffffe3d558aeb16482902206bf63bbfb8b20f7 [formerly 0cada152274f62b1eff9208f18b8d78cca57b860 [formerly c018b6e1e607133b04d038be4b5c514fd97aa4cc]]
Former-commit-id: 9408757cdf469a98e2b8c12fee05187057d96617 [formerly 14d0e5b5175943b613c6bfd535ccf3b344550e57]
Former-commit-id: 030343c8b7117380c8e703b19f17f30b69c93e64
This commit is contained in:
Jaifroid 2021-06-10 12:06:55 +01:00 committed by GitHub
parent 83076af6b3
commit 96157210e0
1 changed files with 0 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -30,18 +30,12 @@ It can also be installed (in Windows 10) by opening a Command Prompt or PowerShe
You will need a ZIM file to work with this app. For testing, the Store version comes packaged with an archive of the top 100 Wikipedia pages in English
(with pictures) as a starter ZIM, while packaged aps of WikiMed and Wikivoyage are also available in the Store or from [Releases](https://github.com/kiwix/kiwix-js-windows/releases/). You can download other ZIM archives from the Configuration page in the app (the download completes in the browser).
Place the file in an accessible location on your device, and use the Select Storage button in the app to display buttons that
let you pick the file or the file's folder (if you do not see such buttons, look under Expert Settings in Config to enable the file picking UI).
Alternatively, you can download files from the [Kiwix repository](http://wiki.kiwix.org/wiki/Content_in_all_languages)
on a regular PC. If you plan to store your ZIM file on an SD card formatted as FAT32, and you wish to use an archive larger than 4GB, then you will need
to split the ZIM: see [file splitting instructions](https://github.com/kiwix/kiwix-js-windows/tree/master/AppPackages#download-a-zim-archive-all-platforms).
If your SD card is formatted as exFAT or NTFS, you do not need to split the ZIM archive.
You can also run the app from your own File system, either from the file:// protocol (in some browsers) or from your own local server. Some functionality is limited
in these contexts (e.g. you have to authorize access to a file each time you access the app in browser context). The PWA version in Chromium browsers (including Edge) uses the
File System Access API which means you only have to give permission with a single click.
A lot of development for this app happens upstream in the [Kiwix JS repository](https://kiwix.github.io/kiwix-js/) to which I ontribute actively.
Without Kiwix JS, this app would be impossible, and huge thanks goes to the original developers of first the Evopedia app and then Kiwix HTML5, which
eventually became Kiwix JS. The original source code runs almost "as is" on the UWP platform, which is testament to how well written that app is.