mirror of
https://github.com/kiwix/kiwix-js-pwa.git
synced 2025-09-18 16:58:26 -04:00
Update release templates
Former-commit-id: 5089720ae7a586d99095bee4edb77fe60c9d2134 [formerly 81e87a5e3c178b55ffa51747d5846a17524d4973] [formerly d122df2f48f98572693a418609f23c7e245af9dd] [formerly 2d41869b1d49c7a6d269eb99eee3f744118038ef [formerly f76edaeb526b9f2a2e79f14661329320808f67fd [formerly 8974eefcb67a9be2ac8358238c0957514f1618c9]]] Former-commit-id: 0a081cca5f0ffdf7ed7563fe29fd7a7508c5b885 [formerly 8c496f05aaecae58ff8aa202668643cd3a596346 [formerly 0deb0678aa3598141eda3305018ce2e9e36c81d2]] Former-commit-id: 936ac6bd8a52aedb1545e064fd8bc5b8a645a242 [formerly 57fb378d3db49627f40c994edc5ab1e0f2667d5c] Former-commit-id: 1ce0a7766c76c662fdfab6176c3e30ede9531c0e
This commit is contained in:
Jaifroid
parent
45f04b44ea
commit
c15ab7bb55
@ -8,10 +8,10 @@ Choose the correct build (**warning: the download is at least 1.2GB**):
|
||||
|
||||
* **Windows**:
|
||||
- **Portable** (just unzip, no install needed)
|
||||
+ Win7/8/10/11 - [Kiwix JS WikiMed <<base_tag>>.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.<<base_tag>>.zip)
|
||||
+ Windows 7/8/10/11 - [Kiwix JS WikiMed <<base_tag>>.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.<<base_tag>>.zip)
|
||||
- **Installable**
|
||||
+ Win7/8/10/11 - [Kiwix JS WikiMed Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.Setup.<<numeric_tag>>-E.exe)
|
||||
* **Linux**
|
||||
+ Windows 7/8/10/11 - [Kiwix JS WikiMed Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.Setup.<<numeric_tag>>-E.exe)
|
||||
* **Linux**:
|
||||
- **Portable**
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS WikiMed-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed-<<numeric_tag>>-E.AppImage)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS WikiMed-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed-<<numeric_tag>>-E-i386.AppImage)
|
||||
@ -27,8 +27,8 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
|
||||
* For the Windows Portable build, unzip the contents of the [Kiwix JS WikiMed <<base_tag>>.zip archive](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.<<base_tag>>.zip) archive to any folder, or to a flash drive / thumb drive, and double click on `Start Kiwix JS WikiMed` or `Start Kiwix JS WikiMed.bat`, or open the `kiwix-js-windows-win32-ia32` folder and double click on `kiwix-js-windows.exe`.
|
||||
* For the Windows Setup (installable) build, simply download and launch. It will install itself, together with a shortcut in your shortcut menu, and run. When you want to update the app, just install a new version over it (it will uninstall the old one for you).
|
||||
* For the Linux potable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn’t work, open Terminal and run `chmod a+x Kiwix.JS.WikiMed*.AppImage` and then `./Kiwix.JS.WikiMed*.AppImage`. On **Debian**, you will probably need to add the `--no-sandbox` switch to the command like this `./Kiwix.JS.WikiMed*.AppImage --no-sandbox` (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). On **OpenSUSE**, you may need to use these commandline switches instead: `./Kiwix.JS.WikiMed*.AppImage --use-gl=disabled --disable-gpu-compositing`.¹
|
||||
* For the Linux installable builds, download the correct `.deb` package and double-click to see if your graphical package manager can install it. If not, open a terminal, `cd` to the directory containing the package, and type `sudo apt install ./kiwix-js-wikimed*.deb`. Once installed, on **Debian**, you may have to run the app by opening terminal and typing `kiwix-js-wikimed --no-sandbox`. On **Ubuntu**, you should be able to run it from its installed icon. When you want to update, just install the new version, and it will install over the old version. To install on **OpenSUSE**, it may be easiest to extract the files from the AppImage instead of using the Deb package. The executable is `kiwix-js-wikimed` and you may need to add the commandline switches `--use-gl=disabled --disable-gpu-compositing`.¹
|
||||
* For the Linux portable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn’t work, open Terminal and run `chmod a+x Kiwix.JS.WikiMed*.AppImage` and then `./Kiwix.JS.WikiMed*.AppImage`. On **Debian**, you will probably need to add the `--no-sandbox` switch to the command like this `./Kiwix.JS.WikiMed*.AppImage --no-sandbox` (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). On **OpenSUSE**, you may need to use these commandline switches instead: `./Kiwix.JS.WikiMed*.AppImage --use-gl=disabled --disable-gpu-compositing`.¹
|
||||
* For the Linux installable builds, download the correct `.deb` package. Open a terminal, `cd` to the directory containing the package, and type `sudo apt install ./kiwix-js-wikimed*.deb`. Once installed, on **Debian**, you may have to run the app by opening terminal and typing `kiwix-js-wikimed --no-sandbox`. On **Ubuntu**, you should be able to run it from its installed icon. When you want to update, just install the new version, and it will install over the old version. To install on **OpenSUSE**, it may be easiest to extract the files from the AppImage instead of using the Deb package. The executable is `kiwix-js-wikimed` and you may need to add the commandline switches `--use-gl=disabled --disable-gpu-compositing`.¹
|
||||
* Windows: **Because the portable archive may not be commonly downloaded, you may face Windows SmartScreen issues** on first launch. Follow instructions to "Run anyway" if you trust this site. If you prefer, use the installable version [Kiwix JS WikiMed Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>-WikiMed/Kiwix.JS.WikiMed.Setup.<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
|
||||
¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.
|
||||
@ -40,7 +40,7 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
* It supports dark mode, and opening different navigable windows by right-clicking or ctrl-clicking a link (see Configuration);
|
||||
* You can print by pressing Ctrl-P or using the print icon. If local printers are not available (after clicking on More options...) then print to PDF and use another app to print;
|
||||
* You can open a new browsable window by right-clicking, middle-clicking or ctrl-clicking an article link;
|
||||
* In title search, you can use wildcards `.*` or `.+` *so long as the search starts with a normal alphanumeric string* - you cannot start with a wildcard. You can include a more complex regular expression by enclosing it within `(?:my_regular_expression)`. If you use wildcards or an enclosed regex, *the entire string must be a valid regular expression or it will not run*. If you do not use wildcards or a regex, the string will be treated as a simple string that will match the beginning of a title. Title search is pseudo-case-insensitive (it is best to use all lowercase), but the number of case combinations attempted is necessarily limited.
|
||||
* In title search, you can use wildcards `.*` or `.+` (this works best if you start the search with a normal alphanumeric string). You can include a more complex regular expression by enclosing it within `(?:my_regular_expression)`. See Configuration -> About for more details and limitations.
|
||||
|
||||
### Known Issues
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
This is **not** the UWP/Microsoft Store build. If you are using Windows 10 or 11, we strongly recommend [the Kiwix JS UWP release](https://kiwix.github.io/kiwix-js-windows/kiwix-js-uwp.html), which will keep itself up-to-date automatically. These portable and installable versions run on the included [Electron platform](https://www.electronjs.org/) version 10.4.0 and [NWJS](https://nwjs.io/) 0.54.0 (Win7/8/10) or 0.14.7 (XP/Vista).
|
||||
|
||||
They are packaged with the <<date>> sample ZIM of the top 100 Wikipedia articles in English, `<<zim>>`. These builds will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu and Debian).
|
||||
They are packaged with the <<date>> sample ZIM of the top 100 Wikipedia articles in English, `<<zim>>`. These builds will run on 32bit and 64bit editions of Windows or Linux (tested on Ubuntu, Debian and OpenSUSE - but see instructions below).
|
||||
|
||||
Choose the correct build:
|
||||
|
||||
@ -11,11 +11,11 @@ Choose the correct build:
|
||||
+ Windows 7/8/10/11 - [kiwix_js_windows-<<numeric_tag>>N-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-<<numeric_tag>>N-win-ia32.zip) (NWJS) - _recommended_
|
||||
+ Windows XP/Vista - [kiwix_js_windows-XP-<<numeric_tag>>N-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-XP-<<numeric_tag>>N-win-ia32.zip) (NWJS)
|
||||
- **Installable** (signed NSIS installer)
|
||||
+ Windows 7/8/10 - [Kiwix JS Windows Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.PWA.Setup.<<numeric_tag>>-E.exe) (Electron)
|
||||
+ Windows 7/8/10/11 - [Kiwix JS Windows Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.PWA.Setup.<<numeric_tag>>-E.exe) (Electron)
|
||||
* **Linux**:
|
||||
- **Portable**
|
||||
+ AppImage 64bit (Ubuntu, Debian) - [Kiwix JS PWA-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.PWA-<<numeric_tag>>-E.AppImage) (Electron)
|
||||
+ AppImage 32bit (Ubuntu, Debian) - [Kiwix JS PWA-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.PWA-<<numeric_tag>>-E-i386.AppImage) (Electron)
|
||||
+ AppImage 64bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS PWA-<<numeric_tag>>-E.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.PWA-<<numeric_tag>>-E.AppImage) (Electron)
|
||||
+ AppImage 32bit (Ubuntu, Debian, OpenSUSE) - [Kiwix JS PWA-<<numeric_tag>>-E-i386.AppImage](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.PWA-<<numeric_tag>>-E-i386.AppImage) (Electron)
|
||||
- **Installable**
|
||||
+ Deb package 64bit (Ubuntu, Debian) - [kiwix-js-pwa_<<numeric_tag>>-E_amd64.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-pwa_<<numeric_tag>>-E_amd64.deb) (Electron)
|
||||
+ Deb package 32bit (Ubuntu, Debian) - [kiwix-js-pwa_<<numeric_tag>>-E_i386.deb](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix-js-pwa_<<numeric_tag>>-E_i386.deb) (Electron)
|
||||
@ -28,9 +28,10 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
|
||||
* For the Windows Portable build, unzip the contents of the [kiwix_js_windows-<<base_tag>>-win-ia32.zip](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/kiwix_js_windows-<<numeric_tag>>N-win-ia32.zip) archive (or the XP version if you're using that) to any folder, or to a flash drive / thumb drive, and double click on `Start Kiwix JS Windows` or `Start Kiwix JS Windows via batch file.bat`, or open the `kiwix_js_windows-...` folder and double click on `nw.exe`;
|
||||
* For the Windows Setup (installable) build, simply download and launch. It will install itself, together with a shortcut in your shortcut menu, and run. When you want to update the app, just install a new version over it (it will uninstall the old one for you).
|
||||
* For the Linux portable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn't work, open Terminal and run `chmod a+x Kiwix.JS.PWA*.AppImage` and then `./Kiwix.JS.PWA*.AppImage --no-sandbox`. You might be able to run without `--no-sandbox` (see https://github.com/electron/electron/issues/17972#issuecomment-516957971).
|
||||
* For the Linux installable builds, download the correct `.deb` package. Open a terminal, `cd` to the directory containing the package, and type `sudo apt install ./kiwix-js-pwa*.deb`. Once installed, on Debian, you may have to run the app by opening terminal and typing `kiwix-js-pwa --no-sandbox`. On Ubuntu, you should be able to run it from its installed icon. When you want to update, just install the new version, and it will install over the old version.
|
||||
* For the Linux portable builds, download and save the correct AppImage file anywhere (e.g. your Desktop), and double-click it. If it doesn’t work, open Terminal and run `chmod a+x Kiwix.JS.PWA*.AppImage` and then `./Kiwix.JS.PWA*.AppImage`. On **Debian**, you will probably need to add the `--no-sandbox` switch to the command like this `./Kiwix.JS.PWA*.AppImage --no-sandbox` (see https://github.com/electron/electron/issues/17972#issuecomment-516957971). On **OpenSUSE**, you may need to use these commandline switches instead: `./Kiwix.JS.WikiMed*.AppImage --use-gl=disabled --disable-gpu-compositing`.¹
|
||||
* For the Linux installable builds, download the correct `.deb` package. Open a terminal, `cd` to the directory containing the package, and type `sudo apt install ./kiwix-js-pwa*.deb`. Once installed, on **Debian**, you may have to run the app by opening terminal and typing `kiwix-js-pwa --no-sandbox`. On **Ubuntu**, you should be able to run it from its installed icon. When you want to update, just install the new version, and it will install over the old version. To install on **OpenSUSE**, it may be easiest to extract the files from the AppImage instead of using the Deb package. The executable is `kiwix-js-wikimed` and you may need to add the commandline switches `--use-gl=disabled --disable-gpu-compositing`.¹
|
||||
* Windows: **Because the portable archive may not be commonly downloaded, you may face Windows SmartScreen issues** on first launch. Follow instructions to "Run anyway" if you trust this site. If you prefer, use the installable version [Kiwix JS Windows Setup <<numeric_tag>>-E.exe](https://github.com/kiwix/kiwix-js-windows/releases/download/v<<base_tag>>/Kiwix.JS.PWA.Setup.<<numeric_tag>>-E.exe) which is digitally signed.
|
||||
¹ With many thanks to Jay Midura for documenting the switches needed for OpenSUSE.
|
||||
|
||||
### Release Notes
|
||||
|
||||
@ -38,12 +39,13 @@ There is no installation required for the Portable versions. NONE of these build
|
||||
* You can download many different archives in multiple languages from the Configuration page;
|
||||
* It supports dark mode, and opening different navigable windows by right-clicking or ctrl-clicking a link (see Configuration);
|
||||
* You can print by pressing Ctrl-P or using the print icon. If local printers are not available (after clicking on More options...) then print to PDF and use another app to print;
|
||||
* You can open a new browsable window by right-clicking, middle-clicking or ctrl-clicking an article link.
|
||||
* You can open a new browsable window by right-clicking, middle-clicking or ctrl-clicking an article link;
|
||||
* In title search, you can use wildcards `.*` or `.+` (this works best if you start the search with a normal alphanumeric string). You can include a more complex regular expression by enclosing it within `(?:my_regular_expression)`. See Configuration -> About for more details and limitations.
|
||||
|
||||
### Known Issues
|
||||
|
||||
* REGRESSION: Due to a change in format, headings are always open in jQuery mode regardless of the "Open all sections" option in Configuration (the setting is respected in Service Worker mode);
|
||||
* INCONSISTENCY: When printing in jQuery mode, all sections are opened before printing (if the user had closed any), whereas in SW mode, closed sections are not opened before printing;
|
||||
* On the XP build with some recent ZIMs (not the packaged one), __there is a CSS error in rendering the landing page of this ZIM__, due to the age of the Chromium build included in the runtime package. However, you can access all articles by __pressing a space in the search box__;
|
||||
* If you download an archive from within the app (from Configuration), you will be able to pick a download directory, and the download will start, but then there will be no further indication that a download is in progress. You will need to check the chosen download directory to see if the download has completed.
|
||||
* If you download an archive from within the app (from Configuration), you will be able to pick a download directory, and the download will start, but then there will be no further indication that a download is in progress. You will need to check the chosen download directory to see if the download has completed;
|
||||
* Please see https://github.com/kiwix/kiwix-js-windows/issues for further known issues. If you find a new issue, please open a new issue on that page.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user