README.md

   1       ###################################################################
   2       ##                          Geeqie x.x                           ##
   3       ##                                                               ##
   4       ##              Copyright (C) 2008 - 2017 The Geeqie Team        ##
   5       ##              Copyright (C) 1999 - 2006 John Ellis.            ##
   6       ##                                                               ##
   7       ##                      Use at your own risk!                    ##
   8       ##                                                               ##
   9       ##  This software released under the GNU General Public License. ##
  10       ##       Please read the COPYING file for more information.      ##
  11       ###################################################################
  12
  13 This is Geeqie, a successor of GQview.
  14
  15 [![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
  16
  17 Geeqie has been forked from GQview project, because it was not possible to
  18 contact GQview author and the only maintainer. Geeqie projects goal is to move
  19 the development forward and also integrate the existing patches.
  20
  21 Geeqie is currently considered stable. Please report any crash or odd behavior
  22 to the [mailing list](https://lists.sourceforge.net/lists/listinfo/geeqie-devel)
  23 and/or to [Github](https://github.com/BestImageViewer/geeqie/issues)
  24
  25 For more info see: <http://www.geeqie.org/>
  26
  27 Please send any question or suggestions to <geeqie-devel@lists.sourceforge.net> or
  28 open an issue on <https://github.com/BestImageViewer/geeqie/issues>
  29
  30 # README contents:
  31
  32 * Requirements
  33 * Notes and changes for this release
  34 * Downloading
  35 * Installation
  36 * Description / Features
  37
  38 ## Requirements
  39
  40 ### Required libraries:
  41     GTK+ 3.00
  42         www.gtk.org
  43         enabled by default
  44         disable with configure option: --disable-gtk3
  45     or
  46     GTK+ 2.20
  47         disabled by default when GTK+3 libraries are found.
  48         enable with configure option: --disable-gtk3
  49         optional items map display and GPU acceleration are not available
  50         with GTK2
  51
  52         Note: GTK+3 is still somehow experimental. It is needed for some
  53         features but we have several complains about the GTK+3 usability.
  54
  55         So if you need a stable version, you are advised to compile it
  56         with GTK+2. If you want to play with the cool new features, use
  57         GTK+3.
  58
  59 ### Optional libraries:
  60     lcms2 2.0
  61     or
  62     lcms 1.14
  63         www.littlecms.com
  64         for color management support
  65         enabled by default
  66         disable with configure option: --disable-lcms
  67
  68     exiv2 0.11
  69         www.exiv2.org
  70         for enhanced exif support
  71         enabled by default
  72         disable with configure option: --disable-exiv2
  73
  74     lirc
  75         www.lirc.org
  76         for remote control support
  77         enabled by default
  78         disable with configure option: --disable-lirc
  79
  80     libchamplain-gtk 0.12
  81     libchamplain 0.12
  82     libclutter 1.0
  83         wiki.gnome.org/Projects/libchamplain
  84         for map display
  85         disabled by default
  86         enable with configure option: --enable-map
  87         enabling will also enable GPU acceleration
  88
  89     libclutter 1.0
  90         www.clutter-project.org
  91         for GPU acceleration (a check-box on Preferences/Image must also be ticked)
  92         disabled by default
  93         enable with configure option: --enable-gpu-accel
  94         explicitly disabling will also disable the map feature
  95
  96     lua 5.1
  97         www.lua.org
  98         support for lua scripting
  99         enabled by default
 100         disable with configure option: --disable-lua
 101
 102     awk
 103         when running Geeqie, to use the geo-decode function
 104
 105     markdown
 106         when compiling Geeqie, to create this file in html format
 107
 108
 109 ## Notes and changes for this release            [section:release_notes]
 110
 111 See NEWS file.
 112
 113 ### Code hackers:
 114
 115 If you plan on making any major changes to the code that will be offered for
 116 inclusion to the main source, please contact us first - so that we can avoid
 117 duplication of effort.
 118                                                          The Geeqie Team
 119
 120 ### Known bugs:
 121
 122 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>
 123
 124
 125 ## Downloading
 126
 127 Geeqie is available as a package with some distributions.
 128
 129 The source tar of the latest release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
 130
 131 To download the sources of the latest commits you must have installed git:
 132
 133 Either: `git clone git://www.geeqie.org/geeqie.git`
 134
 135 Or: `git clone http://www.geeqie.org/git/geeqie.git`
 136
 137
 138 ## Installation
 139
 140 Update secondary help documents (optional -  requires use of git):
 141         `./gen_changelog.sh ; markdown README.md > README.html`
 142
 143 Show compile options: `./autogen.sh --help`
 144
 145 Compilation: `./autogen.sh ; make`
 146
 147 General install: `[sudo] make install`
 148
 149 Removal: `[sudo] make uninstall`
 150
 151 ## Description / Features
 152
 153 Geeqie is a graphics file viewer. Basic features:
 154
 155 * Single click image viewing / navigation.
 156 * Zoom functions.
 157 * Thumbnails, with optional caching and .xvpics support.
 158 * Multiple file selection for move, copy, delete, rename, drag and drop.
 159 * Drag and drop.
 160 * Slideshow.
 161 * Full screen.
 162 * Ability to open images in external editors (configurable).
 163 * Collections.
 164 * Comparison of images to find duplicates by name, size, date, dimensions, or image content similarity.
 165     * Rotation invariant detection
 166 * EXIF support.
 167 * support for stereoscopic images
 168     * input: side-by-side (JPS) and MPO format
 169     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
 170