Bug fix: Non-portable functions
[geeqie.git] / README.md
index b8a433f..b5b23f0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
+
       ###################################################################
       ##                          Geeqie x.x                           ##
       ##                                                               ##
-      ##              Copyright (C) 2008 - 2017 The Geeqie Team        ##
+      ##              Copyright (C) 2008 - 2021 The Geeqie Team        ##
       ##              Copyright (C) 1999 - 2006 John Ellis.            ##
       ##                                                               ##
       ##                      Use at your own risk!                    ##
@@ -12,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.
 
@@ -24,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
@@ -31,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:
 
@@ -65,12 +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, BMP, CR2, CRW, CUR, DNG, ERF, GIF, ICNS, ICO, JPE/JPEG/JPG, JPS, KDC, MEF, MPO, MOS, MRW, NEF, ORF, PEF, PTX, PBM/PGM/PNM/PPM, PNG, QIF/QTIF (QuickTime Image Format), RAF, RAW, RW2, SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, 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.
 
@@ -98,27 +101,48 @@ Geeqie is a graphics file viewer. Basic features:
 
 * 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.
+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.
+
+The first script will install Geeqie to a defined location, and will run under any system. However, it is left to you to make sure dependencies are fulfilled.
+To get the script, from the command line type:<br/><br/>
+`wget https://raw.githubusercontent.com/pixlsus/Scripts/master/build-geeqie`
+
+The second script will run only on Debian-based system, but will fulfil all dependencies and also give you the opportunity to include additional pixbuf loaders and other useful programs.
+To get the script, from the command line type:<br/><br/>
+`wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/web/geeqie-install-debian.sh`
 
-The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
 
-However Geeqie is stable, and 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://www.geeqie.org/geeqie.git`
 
 Or: `git clone http://www.geeqie.org/git/geeqie.git`
 
-
-## Installation
+## Manual Installation
 
 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`
 
@@ -160,12 +184,8 @@ And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gi
         optional items map display and GPU acceleration are not available
         with GTK2
 
-        Note: GTK+3 is still somehow experimental. It is needed for some
-        features but we have several complains about the GTK+3 usability.
-
-        So if you need a stable version, you are advised to compile it
-        with GTK+2. If you want to play with the cool new features, use
-        GTK+3.
+        Both GTK2 and GTK3 versions have been in use for several
+        years, and both may be considered stable.
 
 ### Optional libraries:
     lcms2 2.0
@@ -232,6 +252,40 @@ And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gi
         for displaying pdf files
         disable with configure option: --disable-pdf
 
+    libimage-exiftool-perl
+        For the jpeg extraction plugin
+
+    liblcms2-utils
+        For the command-line tool jpgicc, used by the jpeg extraction plugin
+
+     ImageMagick
+     exiftran
+     gphoto2
+     ufraw
+     exiv2
+        Additional command-line tools for various operations
+
+    libheif
+        For displaying HEIF images
+
+    libwebp
+        For displaying webp images
+
+    libdjvulibre
+        For displaying DjVu images
+
+    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
+
 ### Code hackers:
 
 If you plan on making any major changes to the code that will be offered for