Fix #775: GTK3 and the readme.md
[geeqie.git] / README.md
index 9fb4ad4..0030a9a 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,10 @@
+
+##PLEASE NOTE!
+The repository at GitHub is not the main repository, and is likely to be out-of-date.  
+If you wish to clone the source code, please use the repository at [geeqie.org](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).  
+Details are given in the [Downloading](#downloading) section below.
+###########################################################################  
+
       ###################################################################
       ##                          Geeqie x.x                           ##
       ##                                                               ##
@@ -70,7 +77,7 @@ 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, 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, BMP, CR2, CRW, CUR, DNG, ERF, GIF, HEIC, 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, HEIF, WEBP, DjVu, PSD, JP2. Animated GIFs are supported.
 
 * Preview and thumbnails of video clips can be displayed. Clips can be run via a defined external program.
 
@@ -98,19 +105,29 @@ 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.
 
+# <a name="downloading"></a>
 ## 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.
+
+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`
 
-However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
+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`
 
-For Ubuntu and other Debian-based systems, [this script](http://www.geeqie.org/web/geeqie-install-debian.sh) will download Geeqie sources, all dependencies, and compile and install Geeqie. You may also select which optional libraries to install.
-
-## Installation
+## Manual Installation
 
 List compile options: `./autogen.sh --help`
 
@@ -159,12 +176,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
@@ -231,12 +244,33 @@ And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gi
         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
+
+    libheif
+        For displaying HEIF images
+
+    libwebp
+        For displaying webp images
+
+    libdjvulibre
+        For displaying DjVu images
+
+    libopenjp2
+        For displaying JP2 images
+
+    yelp-tools
+        For creating the Help files
 
 ### Code hackers: