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

Update README.md

Browse Source 
Former-commit-id: 7fdb6a2fdbe0958dc70ea5040d37de593dc22931 [formerly 1093495cacf15bbda0df00e2d65c378e1ce8743b] [formerly eaf561a070e0bf91e5b6a7251e970d3a465522bc] [formerly 476e05dc67babfc0b91b84f2d6791c7670d92851 [formerly c5c23d5b602d21452b7b60310844d08353d70489 [formerly 39ed26e5626f0edc645b252fb1d96ac39ed3ab15]]]
Former-commit-id: 570e9084e462e5d91cce37cb8075091ad1b15110 [formerly c0a2df7d2a1df42ae5e5cdb0f15d5a22918c6137 [formerly 76937499901ccc49ac4c568f8c48df63d3fc68c3]]
Former-commit-id: 3174af17192bd3f475e699247362919545286f87 [formerly 45d53aaf6aef2936d9e254034e0c27de666176ad]
Former-commit-id: 502bf6777bad07f234dd8019109d49b4aa63d146
This commit is contained in:
Jaifroid 2021-06-10 14:26:11 +01:00 committed by GitHub
parent 96157210e0
commit db8366e73a
1 changed files with 13 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
AppPackages/README.md
View File

@ -4,21 +4,24 @@ The easiest way to install Kiwix JS Windows is from the Microsoft Store:
https://www.microsoft.com/en-gb/store/p/kiwix-js/9p8slz4j979j
If you prefer not to (or cannot) use the Microsoft Store or wish to test a different build, please follow the instructions below. _Uninstall any previous installation of Kiwix JS Windows before you follow this procedure_.
The second easiest way is to open a Command Prompt (Win key -> type "Command" or "Terminal" or "PowerShell") and at the commandline type `winget install kiwix`. If you don't
have [`winget`](https://docs.microsoft.com/en-us/windows/package-manager/winget/) yet, or wish to test a different build, then follow the instructions below. _Uninstall any
previous installation of Kiwix JS Windows before you follow this procedure_.
## Windows 10 Tablet / PC
Starting in Windows 10 version 2004, **sideloading is enabled by default** and you can install apps by double-clicking signed app packages.
On Windows 10 version 1909 and earlier, sideloading requires some additional configuration.
On Windows 10 version 1909 and earlier, sideloading requires some additional configuration, as does sideloading unsigned packages.
* **Simple procedure**: Just launch your package! The Kiwix JS Windows packages downloadable from [Releases](https://github.com/kiwix/kiwix-js-windows/releases/) are signed. Download the `.appxbundle` from the Assets section of a Release and launch it by double-clicking.
* **Simple procedure**: Just try launching your package! The Kiwix JS Windows packages downloadable from [Releases](https://github.com/kiwix/kiwix-js-windows/releases/) are signed. Download the `.appxbundle` from the Assets section of a Release and launch it by double-clicking.
* If you wish to test an unsigned package, find an `.appxbundle` above inside `AppPackages/KiwixWebApp_x.x.x.x_[AnyCPU]_Test/` folders, and try to launch it by double-clicking.
* You may be prompted to allow sideloading, or you may need to enable it first on version 1909 or earlier: go to Settings -> Update and security -> For developers. If this doesn't work, follow procedure below.
* **You will need a ZIM archive to use the full features of this app** - [see below](#download-a-zim-archive-all-platforms).
**_If above procedure fails_**, the package may not be a signed one, or else you have an even older version of Windows 10. In this case, follow the more complex procedure below:
* Put your PC in Developer mode: Settings / Update and security / For developers (it is not enough to select "Sideload" for unsigned packages). Your device may need to download a developer package, install it, and restart.
* Put your PC in Developer mode: Settings / Update and security / For developers (it is not enough to select "Sideload" for unsigned packages). Your device may need to download
* a developer package, install it, and restart.
* Then, launch a PowerShell command window: press Windows key and type PowerShell, right-click and "Run as Administrator".
* Type the following command: `Set-ExecutionPolicy -ExecutionPolicy Unrestricted -Scope CurrentUser`
* Accept the warnings and ensure the script finished correctly. (The above steps are one-time only: you shouldn't need to repeat them to install future builds.)
@ -39,4 +42,9 @@ You will need a ZIM file to work with this app. For testing, it comes packaged e
Alternatively, you can download files from http://wiki.kiwix.org/wiki/Content_in_all_languages on a regular PC. Some ZIM files are very large (full English Wikipedia with images is over 90GB) -- we suggest you use BitTorrent to download these files: the app will provide you with a BitTorrent link for large files - just open the download Library in Configuration, browse for your ZIM and click on it: an information page with links will be shown.
If you plan to store your ZIM file on an SD card formatted as **FAT32**, you may need to use a programme like [File Splitter and Joiner](http://www.fastfilejoiner.com/) to split the file into 4GiB-1 chunks (chunks must be exactly 4,294,967,295 bytes or less). You will need to give a file extension to each chunk in the right order following this pattern: `*.zimaa`, `*.zimab`, `*.zimac`, `...`, etc.). However, if your SD card is formatted as exFAT or NTFS, you *do not need to do this*.
### Splitting your ZIM archive (for FAT32 storage)
If you plan to store your ZIM file on an SD card or other drive formatted as **FAT32**, you may need to use a programme like
[File Splitter and Joiner](http://www.fastfilejoiner.com/) to split the file into 4GiB-1 chunks (chunks must be exactly 4,294,967,295 bytes **or less**). You will need to give a
file extension to each chunk in the right order following this pattern: `*.zimaa`, `*.zimab`, `*.zimac`, `...`, etc.). However, if your SD card is formatted as exFAT or NTFS,
you *do not need to do this*.