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 the GQview author and only maintainer.
  19
  20 The Geeqie project will continue the development forward and maintain the existing code.
  21
  22 Geeqie is currently considered stable.
  23
  24 For questions, problems or suggestions, please open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
  25
  26 The project website is <http://www.geeqie.org/> and you will find the latest sources in the
  27 [Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
  28
  29 # README contents:
  30
  31 * Description / Features
  32 * Downloading
  33 * Installation
  34 * Notes and changes for this release
  35 * Requirements
  36
  37
  38 ## Description / Features
  39
  40 Geeqie is a graphics file viewer. Basic features:
  41
  42
  43 * Single click image viewing / navigation.
  44
  45 * Zoom functions.
  46
  47 * Thumbnails, with optional caching and .xvpics support.
  48
  49 * Multiple file selection for move, copy, delete, rename, drag and drop.
  50
  51 * Thumbnail preview of the destination for move, copy and rename functions.
  52
  53 * On-the-fly renaming for move and copy functions, with formatted and auto-rename features.
  54
  55 * File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).
  56
  57 * Selectable exif auto-rotation of images.
  58
  59
  60 * Single click file copy or move to pre-defined folders - with undo feature.
  61 * Drag and drop.
  62
  63 * Collections.
  64
  65 * support for stereoscopic images
  66     * input: side-by-side (JPS) and MPO format
  67     * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
  68
  69 *   Viewing raster and vector images, in the following formats:
  70 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.
  71
  72 * 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.
  73
  74 * Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
  75 * All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
  76
  77 * Selectable image overlay display box - can contain any text or meta-data.
  78
  79 * Panels can be docked or floating.
  80
  81 * Tags, both predefined and custom, can be assigned to images, and stored either as image metadata (where the file format allows), sidecar files, or in directory metadata files. Keywords and comments can also be assigned.
  82
  83 * Basic editing in the form of lossless 90/180-degree rotation and flipping is supported; external programs such as GIMP, Inkscape, and custom scripts using ImageMagick can be linked to allow further processing.
  84
  85 * Advanced searching is available using criteria such as filename, file size, age, image dimensions, similarity to a specified image, or by keywords or comments. If images have GPS coordinates embedded, you may also search for images within a radius of a geographical point.
  86
  87 * Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
  88
  89 * Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
  90
  91 * Geeqie includes a 'find duplicates' tool which can compare images using a variety of criteria (filename, file size, visual similarity, dimensions, image content), either within a single folder or between two folders. Finding duplicates ignoring the rotation of images is also supported.
  92 * Images may be given a rating value (also known as a "star rating").
  93
  94 * 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.
  95
  96 ## Downloading
  97
  98 Geeqie is available as a package with some distributions.
  99
 100 The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
 101
 102 However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
 103
 104 Either: `git clone git://www.geeqie.org/geeqie.git`
 105
 106 Or: `git clone http://www.geeqie.org/git/geeqie.git`
 107
 108
 109 ## Installation
 110
 111 Update secondary help documents (optional -  requires use of git):
 112         `./gen_changelog.sh ; markdown README.md > README.html`
 113
 114 List compile options: `./autogen.sh --help`
 115
 116 Common options:
 117 `./autogen.sh --disable-gtk3`,
 118
 119 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
 120
 121 Install: `[sudo] make install`
 122
 123 Removal: `[sudo] make uninstall`
 124
 125 #### Note:
 126 The zip files at GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
 127
 128 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.
 129
 130 However if you leave the folder intact, whenever new features or patches are available, execute:
 131
 132 `git pull; sudo make uninstall; sudo make distclean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
 133
 134 Only the changed sources are downloaded, which makes this a quick operation.
 135
 136 Your configuration file, history file and desktop files are not affected by this process.
 137
 138
 139
 140 ## Notes and changes for the latest release
 141
 142 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
 143
 144 And either the ChangeLog file or [Geeqie ChangeLog at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/ChangeLog)
 145
 146
 147 ## Requirements
 148
 149 ### Required libraries:
 150     GTK+ 3.00
 151         www.gtk.org
 152         enabled by default
 153         disable with configure option: --disable-gtk3
 154     or
 155     GTK+ 2.20
 156         disabled by default when GTK+3 libraries are found.
 157         enable with configure option: --disable-gtk3
 158         optional items map display and GPU acceleration are not available
 159         with GTK2
 160
 161         Note: GTK+3 is still somehow experimental. It is needed for some
 162         features but we have several complains about the GTK+3 usability.
 163
 164         So if you need a stable version, you are advised to compile it
 165         with GTK+2. If you want to play with the cool new features, use
 166         GTK+3.
 167
 168 ### Optional libraries:
 169     lcms2 2.0
 170     or
 171     lcms 1.14
 172         www.littlecms.com
 173         for color management support
 174         enabled by default
 175         disable with configure option: --disable-lcms
 176
 177     exiv2 0.11
 178         www.exiv2.org
 179         for enhanced exif support
 180         enabled by default
 181         disable with configure option: --disable-exiv2
 182
 183     lirc
 184         www.lirc.org
 185         for remote control support
 186         enabled by default
 187         disable with configure option: --disable-lirc
 188
 189     libchamplain-gtk 0.12
 190     libchamplain 0.12
 191     libclutter 1.0
 192         wiki.gnome.org/Projects/libchamplain
 193         for map display
 194         enabled by default
 195         disable with configure option: --disable-map
 196
 197     libclutter 1.0
 198         www.clutter-project.org
 199         for GPU acceleration (a check-box on Preferences/Image must also be ticked)
 200         enabled by default
 201         disable with configure option: --disable-gpu-accel
 202         explicitly disabling will also disable the map feature
 203
 204     lua 5.1
 205         www.lua.org
 206         support for lua scripting
 207         enabled by default
 208         disable with configure option: --disable-lua
 209
 210     awk
 211         when running Geeqie, to use the geo-decode function
 212
 213     markdown
 214         when compiling Geeqie, to create this file in html format
 215
 216
 217 ### Code hackers:
 218
 219 If you plan on making any major changes to the code that will be offered for
 220 inclusion to the main source, please contact us first - so that we can avoid
 221 duplication of effort.
 222                                                          The Geeqie Team
 223
 224 ### Known bugs:
 225
 226 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>