Eliminate some GitHub action warnings
[geeqie.git] / README.md
index 1b7b4cc..6d37e30 100644 (file)
--- a/README.md
+++ b/README.md
@@ -29,6 +29,8 @@ The project website is <https://www.geeqie.org/> and you will find the latest so
 
 * [Features](#features)
 * [Downloading](#downloading)
 
 * [Features](#features)
 * [Downloading](#downloading)
+* [AppImages](#appimages)
+* [Installation Scripts](#installation-scripts)
 * [Compiling and Installing](#compiling-and-installing)
 * [Notes and changes for the latest release](#notes-and-changes-for-the-latest-release)
 * [Requirements](#requirements)
 * [Compiling and Installing](#compiling-and-installing)
 * [Notes and changes for the latest release](#notes-and-changes-for-the-latest-release)
 * [Requirements](#requirements)
@@ -64,7 +66,7 @@ Geeqie is a graphics file viewer. Basic features:
     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 
 * Viewing raster and vector images, in the following formats:
     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 
 * Viewing raster and vector images, in the following formats:
-    * 3FR, ANI, APM, ARW, AVIF, BMP, CR2, CR3, CRW, CUR, DDS, DjVu, DNG, ERF, GIF, HEIC, HEIF, ICNS, ICO, JP2. JPE/JPEG/JPG, JPEG XL, JPS, KDC, MEF, MOS, MPO, MRW, NEF, ORF (including OM-1), PBM/PGM/PNM/PPM, PEF, PNG, PSD, PTX, QIF/QTIF (QuickTime Image Format), RAF, RAW, RW2, SCR (ZX Spectrum), SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WEBP, WMF, XBM, XPM.
+    * 3FR, ANI, ARW, AVIF, BMP, CR2, CR3, CRW, CUR, DDS, DjVu, DNG, ERF, GIF, HEIC, HEIF, ICO, JP2. JPE/JPEG/JPG, JPEG XL, JPS, KDC, MEF, MOS, MPO, MRW, NEF, ORF (including OM-1), PBM/PGM/PNM/PPM, PEF, PNG, PSD, QIF/QTIF (QuickTime Image Format), RAF, RAW, RW2, SCR (ZX Spectrum), SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WEBP, XBM, XPM.
     * Display images in archive files (.ZIP, .RAR etc.).
     * Animated GIF and WEBP files are supported.
 
     * Display images in archive files (.ZIP, .RAR etc.).
     * Animated GIF and WEBP files are supported.
 
@@ -106,13 +108,49 @@ Geeqie is available:
 
 * as a [flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home).
 
 
 * as a [flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home).
 
-* as an [AppImage](https://www.geeqie.org/AppImage/index.html) - x86_64 and arm64 (Generated from the latest sources).
+* as an [AppImage](https://github.com/BestImageViewer/geeqie/releases) - x86_64 and arm64 (Generated from the latest sources).
 
 * as a [Homebrew](https://formulae.brew.sh/formula/geeqie) or [MacPorts](https://ports.macports.org/port/geeqie) package for macOS.
 
 * via WSL2 on Windows 11 - see notes below.
 
 
 * as a [Homebrew](https://formulae.brew.sh/formula/geeqie) or [MacPorts](https://ports.macports.org/port/geeqie) package for macOS.
 
 * via WSL2 on Windows 11 - see notes below.
 
-However Geeqie is stable and you may compile the latest version from sources.
+### AppImages
+
+The Continuous Build release version has AppImages that are automatically generated each time the source code is updated. There are two versions - the full version is about 120MB and the minimal version is about 10MB and will therefore load much faster.
+
+The minimal version can display jpegs, pngs and some other formats, but does not have the range of the full version.
+
+This script file will download to $HOME/bin the latest Continuous Build AppImages for you:
+
+```sh
+wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/scripts/geeqie-download-appimage.sh
+chmod +x geeqie-download-appimage.sh
+```
+
+The script can download either the full size or the minimal version of the AppIamge, and sets a symbolic link to the executable file. The ```--help``` option lists all options.
+
+The full version takes a noticeable time to load, and runs slightly slower than a normal packaged release.
+The above script has the option ```--extract``` which extracts the contents of either AppImage to a sub-directory under $HOME/bin.
+With this option the loading and run time is the same as for a packaged release.
+
+There are also options to install desktop icons, menu items, and to revert to earlier downloaded versions.
+
+AppImages have a "portable mode" which is described [here](https://docs.appimage.org/user-guide/portable-mode.html).
+
+**Note:**
+
+Command line auto-completion does not work with AppImages. If you are using the AppImage `--extract` option, this is a work-around.
+
+Assuming you have extracted the AppImage to `$HOME/bin/Geeqie-latest-x86_64-AppImage/`, create a symbolic link as follows:
+
+```sh
+mkdir --parents $HOME/.local/share/bash-completion/completions/
+ln --symbolic $HOME/bin/Geeqie-latest-x86_64-AppImage/squashfs-root/usr/local/share/bash-completion/completions/geeqie $HOME/.local/share/bash-completion/completions/geeqie
+```
+
+### Installation scripts
+
+Geeqie is stable and you may compile the latest version from sources.
 
 There are two scripts which will download and compile the sources for you.
 
 
 There are two scripts which will download and compile the sources for you.
 
@@ -134,9 +172,7 @@ chmod +x geeqie-install-debian.sh
 
 If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
 
 
 If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
 
-Either: `git clone git://git.geeqie.org/geeqie.git`
-
-Or: `git clone http://git.geeqie.org/git/geeqie.git`
+`git clone http://git.geeqie.org/git/geeqie.git`
 
 ### Compiling and Installing
 
 
 ### Compiling and Installing