Releasing stable version
[geeqie.git] / README
diff --git a/README b/README
index 26dad4d..6570ad8 100644 (file)
--- a/README
+++ b/README
@@ -1,39 +1,31 @@
-###################################################################
-##                            Geeqie 1.1                         ##
-##                                                               ##
-##              Copyright (C) 2008 - 2012 The Geeqie Team        ##
-##              Copyright (C) 1999 - 2006 John Ellis.            ##
-##                                                               ##
-##                      Use at your own risk!                    ##
-##                                                               ##
-##  This software released under the GNU General Public License. ##
-##       Please read the COPYING file for more information.      ##
-###################################################################
+      ###################################################################
+      ##                          Geeqie 1.3                           ##
+      ##                                                               ##
+      ##              Copyright (C) 2008 - 2016 The Geeqie Team        ##
+      ##              Copyright (C) 1999 - 2006 John Ellis.            ##
+      ##                                                               ##
+      ##                      Use at your own risk!                    ##
+      ##                                                               ##
+      ##  This software released under the GNU General Public License. ##
+      ##       Please read the COPYING file for more information.      ##
+      ###################################################################
 
 This is Geeqie, a successor of GQview.
 
-Geeqie has been forked from GQview project, because it was not 
-possible to contact gqview author and the only maintainer. 
-Geeqie projects goal is to move the development forward and 
-also integrate the existing patches.
+Geeqie has been forked from GQview project, because it was not possible to
+contact GQview author and the only maintainer. Geeqie projects goal is to move
+the development forward and also integrate the existing patches.
 
-Geeqie is currently considered stable. 
-Please report any crash or odd behavior to the bugtracker:
-https://sourceforge.net/tracker/?group_id=222125&atid=1054680
+Geeqie is currently considered stable. Please report any crash or odd behavior
+to the [mailing list](https://lists.sourceforge.net/lists/listinfo/geeqie-devel)
+and/or to [Github](https://github.com/BestImageViewer/geeqie/issues)
 
-For more info see:
-http://geeqie.sourceforge.net
+For more info see: http://www.geeqie.org/
 
-Vladimir Nadvornik
-Petr Ostadal
+Please send any question or suggestions to geeqie-devel@lists.sourceforge.net or
+open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
 
-Please send any question or suggestions to
-geeqie-devel@lists.sourceforge.net
-
-
-
-
-======== README contents:
+# README contents:
 
     * Requirements
     * Notes and changes for this release
@@ -45,50 +37,92 @@ geeqie-devel@lists.sourceforge.net
     * Translation status
     * Credits
 
-======== Requirements
+## Requirements
 
   Required libraries:
-    GTK+ 2.??.x: ftp://ftp.gtk.org/pub/gtk
-FIXME: determine realistic requirements.
-It compiles with GTK 2.10, but some features are disabled and the testing was
-minimal. Please report success or  falilures.
+    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
+              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.
 
   Optional libraries:
-    lcms, for color management support: http://www.littlecms.com
-        (disable with configure option: '--without-lcms')
-    exiv2, for enhanced exif support: http://www.exiv2.org/
-        (disable with configure option: '--without-exiv2')
-        - due to fast development, newer versions work significantly better
-        FIXME: minimal version ?
-    lirc, for remote control support: http://www.lirc.org/
-       (disable with configure option: '--disable-lirc')
-    libchamplain - experimental map support, dissabled by default
-        http://projects.gnome.org/libchamplain/
-        WARNING: this library has a lot of dependencise
-        
-======== Notes and changes for this release            [section:release_notes]
-
-See http://geeqie.wiki.sourceforge.net/new_features
-
+    lcms2 2.0
+    or
+    lcms 1.14
+               www.littlecms.com
+               for color management support
+               enabled by default
+               disable with configure option: --disable-lcms
+
+    exiv2 0.11
+               www.exiv2.org
+               for enhanced exif support
+               enabled by default
+               disable with configure option: --disable-exiv2
+
+    lirc
+               www.lirc.org
+               for remote control support
+               enabled by default
+               disable with configure option: --disable-lirc
+
+    libchamplain-gtk 0.12
+    libchamplain 0.12
+    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
+
+    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
+               explicitly disabling will also disable the map feature
+
+    lua 5.1
+               www.lua.org
+               support for lua scripting
+               enabled by default
+               disable with configure option: --disable-lua
+
+## Notes and changes for this release            [section:release_notes]
+
+See NEWS file.
 
   Code hackers:
 
-    If you plan on making any major changes to the code that will be offered
-    for inclusion to the main source, please contact us first - so that we
-    can avoid duplication of effort. 
+    If you plan on making any major changes to the code that will be offered for
+    inclusion to the main source, please contact us first - so that we can avoid
+    duplication of effort.
                                                          The Geeqie Team
 
   Known bugs:
 
-    see the Geeqie Bug Tracker at TODO file.
+    See the Geeqie Bug Tracker at TODO file.
 
-======== Installation
+## Installation
 
-  Compilation: ./configure ; make
+  Compilation: ./autogen.sh ; make
   General install: make install
   Removal: make uninstall
 
-======== Description / Features
+## Description / Features
 
   Geeqie is a graphics file viewer. Basic features:
 
@@ -103,17 +137,16 @@ See http://geeqie.wiki.sourceforge.net/new_features
     - Collections.
     - Comparison of images to find duplicates by name, size, date,
       dimensions, or image content similarity.
+      - Rotation invariant detection
     - EXIF support.
-    
-  Geeqie 1.1:
     - support for stereoscopic images
       - input: side-by-side (JPS) and MPO format
       - output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 
-======== Documentation (brief)                         [section:documentation]
+## Documentation (brief)                         [section:documentation]
 
-This sections lists default hotkeys. Most of the hotkeys can be redefined 
-in the Preferences dialog.
+This sections lists default hotkeys. Most of the hotkeys can be redefined in the
+Preferences dialog.
 
   Keyboard commands:
     [PageDown], [Keypad PageDown]      next image
@@ -176,7 +209,7 @@ in the Preferences dialog.
     [Ctrl] - S                         toggle sort manager sidebar
     F, V                               toggle full screen
     S                                  toggle slide show
-    P                                 (Un)pause slideshow
+    P                                 (Un)pause slideshow
     [Ctrl] - V                         display current image in new window
 
   Collection windows:
@@ -269,28 +302,26 @@ in the Preferences dialog.
     Wheel up/down + [Shift]            scroll image up/down
     Wheel up/down + [Control]          zoom image in/out
 
+## Editor command macros                               [section:editors]
 
-======== Editor command macros                               [section:editors]
+Editors are configured via standard desktop files.
 
-Editors are configured via standard desktop files, see
-https://sourceforge.net/apps/trac/geeqie/wiki/GuideEditorsConfig
-
-
-======== Overlay Info                                        [section:overlay]
+## Overlay Info                                        [section:overlay]
 
 Overlay info format string syntax is: %tag[:max_length][:extra]%
 
-  %name%       Filename of the picture.
-  %collection% Name of the collection
-  %number%     Current number of image in the list
-  %total%      Total number of images
-  %date%       File date
-  %size%       File size
-  %width%      Image width
-  %height%     Image height
-  %res%        Image resolution
-  %keywords%   Image keywords from metadata
-  %comment%    Image comment from metadata
+  %name%          Filename of the picture.
+  %collection%    Name of the collection
+  %number%        Current number of image in the list
+  %total%         Total number of images
+  %date%          File date
+  %size%          File size
+  %width%         Image width
+  %height%        Image height
+  %res%           Image resolution
+  %keywords%      Image keywords from metadata
+  %comment%       Image comment from metadata
+  %lua/file.lua/% Lua functionality
 
   To access exif data use the exif name:
   %Exif.Photo.DateTimeOriginal%        Date of the original shot
@@ -312,8 +343,8 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
   formatted.GPSAltitude                GPS altitude
 
   You can limit the length of displayed data using :number notation:
-  %formatted.Camera:20% will truncate the displayed data to 20 characters
-  and will add 3 dots at the end to denote the truncation.
+  %formatted.Camera:20% will truncate the displayed data to 20 characters and
+  will add 3 dots at the end to denote the truncation.
 
   If two or more variables are connected with the |-sign, it prints available
   variables with a separator:
@@ -323,25 +354,22 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
   or
     "1/200 - 80 mm" if there's no ISO information in the Exif data.
 
-  If a line is empty, it is removed.
-  This allows to add lines that totally disappear when no data is available.
+  If a line is empty, it is removed. This allows one to add lines that totally
+  disappear when no data is available.
 
-  Extra string uses special character '*' to mark the position of the data.
-  If no '*' is present, then extra string is just appended to data.
-  Any "\n" is replaced by a newline on display.
-  Pango mark up is accepted in left and right parts.
-  If data is empty, nothing will be displayed.
+  Extra string uses special character '*' to mark the position of the data. If
+  no '*' is present, then extra string is just appended to data. Any "\n" is
+  replaced by a newline on display. Pango mark up is accepted in left and right
+  parts. If data is empty, nothing will be displayed.
 
   Examples:
   "%name:<i>*</i>\n%" -> name is displayed in italics ended with a newline
   "%size:\n%"         -> size is displayed with a newline at end
   "%formatted.ISOSpeedRating:ISO *%"      -> ie. "ISO 100"
-  "Collection <b>*</b>\n" -> display collection name in bold prefixed by
+  "%collection: Collection <b>*</b>\n%" -> display collection name in bold prefixed by
                              "Collection " and a newline is appended
 
-
-======== Credits                                             [section:credits]
-
+## Credits                                             [section:credits]
 
   Translations:
 
@@ -349,6 +377,7 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
      Zbigniew Chyla <cyba@gnome.pl>
      Emil Nowak <emil5@go2.pl>
      Wit Wilinski <wit.wilinski@gmail.com>
+     Tomasz Golinski <tomaszg@math.uwb.edu.pl>
          for Polish translation
 
      Christopher R. Gabriel <cgabriel@pluto.linux.it>
@@ -379,6 +408,7 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
      Kam Tik <kamtik@hongkong.com>
      Abel Cheung <deaddog@deaddog.ws>
      S.J. Luo <crystal@mickey.ee.nctu.edu.tw>
+     Levin <zjlevin@hotmail.com>
          for Traditional Chinese (Big5) translation
 
      Junichi Uekawa <dancer@debian.org>
@@ -476,6 +506,9 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
      Antonio C. Codazzi <f_sophia@libero.it>
          for Esperanto translation
 
+     Nikos Papadopoulos
+        for Greek translation
+
  Fixes, additions, and patches:
 
      Eric Swalens
@@ -509,20 +542,15 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
 
      Timo Horstschäfer
          for customizable fullscreen overlay
-        
+
      Michael Mokeev
          for print related enhancements
-     
+
      Carles Pina i Estany
          for copy path to clipboard patch
+
      Kjell Morgenstern
          for random slide show speedup patch
 
-     Klaus Ethgen <Klaus@Ethgen.de>
-         for GPS integration, Search enhancement and other patches
-
      And...
          Thanks to the users for finding Geeqie useful.
-
-