+
###################################################################
## 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! ##
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.
Geeqie is currently considered stable.
-Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie-devel@lists.sourceforge.net) or
+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).
-Subscribe to the mailing list [here](https://lists.sourceforge.net/lists/listinfo/geeqie-devel).
+(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
[Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
# 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:
* 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, DCR, DNG, ERF, GIF, ICNS, ICO, JPE/JPEG/JPG, JP2/JPC/JPX/J2K/JPF, JPS, K25, KDC, MEF, MPO, MOS, MRW, NEF, ORF, PCX, PEF, PBM/PGM/PNM/PPM, PNG, PTX, QIF/QTIF (QuickTime Image Format), R3D, RAF, RAS (Sun raster), RAW, SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WBMP, WMF, X3F, 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.
* Images can be displayed singly in normal or fullscreen mode; static or slideshow mode; in sets of two or four per page for comparison; or as thumbnails of various sizes. Synchronised zoom when multi images are displayed.
* 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:
-The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
+* as a package for Linux and BSD systems (See the [project web page](https://www.geeqie.org)).
-However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
+* as a [flatpak](https://flathub.org/apps/details/org.geeqie.Geeqie) from the [Flathub site](https://flathub.org/home).
-Either: `git clone git://www.geeqie.org/geeqie.git`
+* as an [AppImage](https://www.geeqie.org/AppImage/index.html) (Generated from the latest sources).
-Or: `git clone http://www.geeqie.org/git/geeqie.git`
+* 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.
-## Installation
+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`
+
+
+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`
-Update secondary help documents (optional - requires use of git):
- `./gen_changelog.sh ; markdown README.md > README.html`
+## 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`
Removal: `[sudo] make uninstall`
#### Note:
-The zip files at GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
+The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
It is recommended to always use `git clone git://www.geeqie.org/geeqie.git` to download Geeqie. After installing Geeqie you may delete the folder you have cloned Geeqie into.
However if you leave the folder intact, whenever new features or patches are available, execute:
-`git pull; sudo make uninstall; sudo make distclean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
+`git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
Only the changed sources are downloaded, which makes this a quick operation.
See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
-And either the ChangeLog file or [Geeqie ChangeLog at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/ChangeLog)
+And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
## Requirements
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
enabled by default
disable with configure option: --disable-lua
+ librsvg2-common
+ for displaying .svg images
+
+ libwmf0.2-7-gtk
+ for displaying .wmf images
+
+ (see also "Additional pixbuf loaders" in the References section of the Help file)
+
awk
when running Geeqie, to use the geo-decode function
markdown
when compiling Geeqie, to create this file in html format
+ libffmpegthumbnailer 2.1.0
+ https://github.com/dirkvdb/ffmpegthumbnailer
+ for thumbnailing camera video clips
+ disable with configure option: --disable-ffmpegthumbnailer
+
+ libpoppler-glib-dev 0.62
+ 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: