Bug fix: Non-portable functions

[geeqie.git] / README.md

diff --git a/README.md b/README.md
index 7d72534..b5b23f0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -13,8 +13,6 @@
 
 This is Geeqie, a successor of GQview.
 
-[![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
-
 Geeqie has been forked from GQview project, because it was not possible to
 contact the GQview author and only maintainer.
 
@@ -25,6 +23,8 @@ Geeqie is currently considered stable.
 Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie@freelists.org) or
 open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
 
+(Unless you first subscribe to the mailing list, you will not receive automated responses)
+
 Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie).
 
 The project website is <http://www.geeqie.org/> and you will find the latest sources in the
@@ -32,14 +32,14 @@ The project website is <http://www.geeqie.org/> and you will find the latest sou
 
 # README contents:
 
-* Description / Features
+* Features
 * Downloading
 * Installation
-* Notes and changes for this release
+* Notes and changes for the latest release
 * Requirements
 
 
-## Description / Features
+## Features
 
 Geeqie is a graphics file viewer. Basic features:
 
@@ -66,13 +66,14 @@ Geeqie is a graphics file viewer. Basic features:
 
 * Collections.
 
-* support for stereoscopic images
+* Support for stereoscopic images
     * input: side-by-side (JPS) and MPO format
     * 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, CRW, CUR, DjVu, DNG, ERF, GIF, HEIC, HEIF, ICNS, ICO, JP2. JPE/JPEG/JPG, JPS, KDC, MEF, MOS, MPO, MRW, NEF, ORF, PBM/PGM/PNM/PPM, PEF, PNG, PSD, PTX, QIF/QTIF (QuickTime Image Format), RAF, RAW, RW2, SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WEBP, WMF, XBM, XPM.
-Animated GIFs are supported.
+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, PBM/PGM/PNM/PPM, PEF, PNG, PSD, PTX, QIF/QTIF (QuickTime Image Format), RAF, RAW, RW2, SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WEBP, WMF, XBM, XPM.
+    * Display images in archive files (.ZIP, .RAR etc.).
+    * Animated GIFs are supported.
 
 * Preview and thumbnails of video clips can be displayed. Clips can be run via a defined external program.
 
@@ -100,10 +101,22 @@ Animated GIFs are supported.
 
 * Maps from [OpenStreetMap](http://www.openstreetmap.org) may be displayed in a side panel. If an image has GPS coordinates embedded, its position will be displayed on the map - if Image Direction is encoded, that will be displayed also. If an image does not have embedded GPS coordinates, it may be dragged-and-dropped onto the map to encode its position.
 
+* Speed of operation can be increased by caching thumbnails and similarity data of images. When Geeqie is run as a stand-alone command line program (`geeqie --cache-maintenance <path>`) these data will be recursively created from the defined start point. This program can be called from `cron` or `anacron` so that cache updating is automatically done at specified intervals.
+
 # <a name="downloading"></a>
 ## Downloading
 
-Geeqie is available as a package with some distributions, however Geeqie is stable and you may compile the latest version from sources.
+Geeqie is available:  
+
+* as a package for Linux and BSD systems (See the [project web page](https://www.geeqie.org)).
+
+* 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) (Generated from the latest sources).
+
+* as a [Homebrew](https://formulae.brew.sh/formula/geeqie) package for macOS.
+
+However 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.
 
@@ -122,8 +135,6 @@ Either: `git clone git://www.geeqie.org/geeqie.git`
 
 Or: `git clone http://www.geeqie.org/git/geeqie.git`
 
-Also [Geeqie is available as a flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home).
-
 ## Manual Installation
 
 List compile options: `./autogen.sh --help`
@@ -131,7 +142,7 @@ List compile options: `./autogen.sh --help`
 Common options:
 `./autogen.sh --disable-gtk3`,
 
-Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
+Compilation: `./autogen.sh [options]; make -j`
 
 Install: `[sudo] make install`
 
@@ -266,6 +277,12 @@ And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gi
     libopenjp2
         For displaying JP2 images
 
+    libraw 0.20
+        For displaying CR3 images
+
+    libarchive 3.4.3
+        For opening archive files (.ZIP, .RAR etc.)
+
     yelp-tools
         For creating the Help files