Preparing stable version
[geeqie.git] / README.md
index e89198e..174efc3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
       ###################################################################
-      ##                          Geeqie x.x                           ##
+      ##                          Geeqie 1.4                           ##
       ##                                                               ##
       ##              Copyright (C) 2008 - 2017 The Geeqie Team        ##
       ##              Copyright (C) 1999 - 2006 John Ellis.            ##
@@ -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.
 
@@ -111,13 +113,10 @@ Or: `git clone http://www.geeqie.org/git/geeqie.git`
 
 ## Installation
 
-Update secondary help documents (optional -  requires use of git):
-        `./gen_changelog.sh ; markdown README.md > README.html`
-
 List compile options: `./autogen.sh --help`
 
 Common options:
-`./autogen.sh --disable-gtk3`,
+`./autogen.sh`,
 
 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
 
@@ -126,13 +125,13 @@ 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.
 
@@ -144,22 +143,22 @@ Your configuration file, history file and desktop files are not affected by this
 
 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.
@@ -210,12 +209,24 @@ 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.0.0
+        https://github.com/dirkvdb/ffmpegthumbnailer
+        for thumbnailing camera video clips
+        disable with configure option: --disable-ffmpegthumbnailer
 
 ### Code hackers: