Preparing release
[geeqie.git] / README.md
index fde9584..d354255 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
       ###################################################################
-      ##                          Geeqie x.x                           ##
+      ##                          Geeqie 1.5                           ##
       ##                                                               ##
-      ##              Copyright (C) 2008 - 2017 The Geeqie Team        ##
+      ##              Copyright (C) 2008 - 2018 The Geeqie Team        ##
       ##              Copyright (C) 1999 - 2006 John Ellis.            ##
       ##                                                               ##
       ##                      Use at your own risk!                    ##
@@ -21,10 +21,10 @@ The Geeqie project will continue the development forward and maintain the existi
 
 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).
+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).
@@ -70,7 +70,9 @@ 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:
-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, 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.
+
+* 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.
 
@@ -98,56 +100,73 @@ Geeqie is a graphics file viewer. Basic features:
 
 ## Downloading
 
-Geeqie is available as a package with some distributions.
+Geeqie is available as a package with some distributions, however Geeqie is stable and you may compile the latest version from sources.
 
-The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
+There are two scripts which will download and compile the sources for you.
 
-However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
+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`
 
-Either: `git clone git://www.geeqie.org/geeqie.git`
+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`
 
-Or: `git clone http://www.geeqie.org/git/geeqie.git`
 
+If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
 
-## Installation
+Either: `git clone git://www.geeqie.org/geeqie.git`
 
-Update secondary help documents (optional -  requires use of git):
-        `./gen_changelog.sh ; markdown README.md > README.html`
+Or: `git clone http://www.geeqie.org/git/geeqie.git`
+
+## Manual Installation
 
 List compile options: `./autogen.sh --help`
 
 Common options:
-`./autogen.sh --disable-gtk3`,
-`./autogen.sh --enable-map`
-
+`./autogen.sh`,
 
-Compilation: `./autogen.sh [options]; make`
+Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
 
 Install: `[sudo] make install`
 
 Removal: `[sudo] make uninstall`
 
+#### Note:
+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 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.
+
+Your configuration file, history file and desktop files are not affected by this process.
+
+
 
 ## Notes and changes for the latest release
 
 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
 
 ### Required libraries:
-    GTK+ 3.00
-        www.gtk.org
-        enabled by default
-        disable with configure option: --disable-gtk3
-    or
     GTK+ 2.20
-        disabled by default when GTK+3 libraries are found.
-        enable with configure option: --disable-gtk3
+        enabled by default even when GTK+3 libraries are found.
+        disable with configure option: --enable-gtk3
         optional items map display and GPU acceleration are not available
         with GTK2
+    or
+    GTK+ 3.00
+        www.gtk.org
+        disabled by default when GTK+2 libraries are found.
+        enable with configure option: --enable-gtk3
 
         Note: GTK+3 is still somehow experimental. It is needed for some
         features but we have several complains about the GTK+3 usability.
@@ -182,15 +201,14 @@ And either the ChangeLog file or [Geeqie ChangeLog at GitHub](https://github.com
     libclutter 1.0
         wiki.gnome.org/Projects/libchamplain
         for map display
-        disabled by default
-        enable with configure option: --enable-map
-        enabling will also enable GPU acceleration
+        enabled by default
+        disable with configure option: --disable-map
 
     libclutter 1.0
         www.clutter-project.org
         for GPU acceleration (a check-box on Preferences/Image must also be ticked)
-        disabled by default
-        enable with configure option: --enable-gpu-accel
+        enabled by default
+        disable with configure option: --disable-gpu-accel
         explicitly disabling will also disable the map feature
 
     lua 5.1
@@ -199,12 +217,48 @@ And either the ChangeLog file or [Geeqie ChangeLog at GitHub](https://github.com
         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
+
+    ZoneDetect
+        For displaying timezone and UTC/DST time offset
+        Download file:
+        https://github.com/BertoldVdb/ZoneDetect/raw/master/database/timezone21.bin
+        and copy to the location of the Geeqie ancilliary files, which is usually:
+        /usr/local/lib/geeqie/
+
+    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
 
 ### Code hackers: