Mercurial > hg > forks > geeqie

annotate README.md @ 2916:ae6cdcd69d9f default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Merge with upstream/master.
author Matti Hamalainen <ccr@tnsp.org>
date Tue, 14 May 2019 11:46:50 +0300
parents cb5326e72117
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
1 ###################################################################
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
2 ## Geeqie x.x ##
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
3 ## ##
2804
c7a8c086862b Enhanced script for compiling on Debian systems
Colin Clark <colin.clark@cclark.uk>
parents: 2799
diff changeset
4 ## Copyright (C) 2008 - 2018 The Geeqie Team ##
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
5 ## Copyright (C) 1999 - 2006 John Ellis. ##
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
6 ## ##
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
7 ## Use at your own risk! ##
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
8 ## ##
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
9 ## This software released under the GNU General Public License. ##
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
10 ## Please read the COPYING file for more information. ##
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
11 ###################################################################
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
12
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
13 This is Geeqie, a successor of GQview.
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
14
2513
c67292329f12 Convert README to markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents:
diff changeset
15 [![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie)
c67292329f12 Convert README to markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents:
diff changeset
16
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
17 Geeqie has been forked from GQview project, because it was not possible to
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
18 contact the GQview author and only maintainer.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
19
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
20 The Geeqie project will continue the development forward and maintain the existing code.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
21
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
22 Geeqie is currently considered stable.
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
23
2691
d89f4d37676c Mailinglist
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2673
diff changeset
24 Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie@freelists.org) or
d89f4d37676c Mailinglist
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2673
diff changeset
25 open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
d89f4d37676c Mailinglist
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2673
diff changeset
26
d89f4d37676c Mailinglist
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2673
diff changeset
27 Subscribe to the mailing list [here](https://www.freelists.org/list/geeqie).
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
28
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
29 The project website is <http://www.geeqie.org/> and you will find the latest sources in the
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
30 [Geeqie repository](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git).
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
31
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
32 # README contents:
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
33
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
34 * Description / Features
2573
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
35 * Downloading
2538
17763b5ff3ea Update README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents: 2537
diff changeset
36 * Installation
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
37 * Notes and changes for this release
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
38 * Requirements
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
39
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
40
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
41 ## Description / Features
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
42
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
43 Geeqie is a graphics file viewer. Basic features:
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
44
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
45
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
46 * Single click image viewing / navigation.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
47
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
48 * Zoom functions.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
49
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
50 * Thumbnails, with optional caching and .xvpics support.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
51
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
52 * Multiple file selection for move, copy, delete, rename, drag and drop.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
53
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
54 * Thumbnail preview of the destination for move, copy and rename functions.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
55
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
56 * On-the-fly renaming for move and copy functions, with formatted and auto-rename features.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
57
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
58 * File grouping (an image having jpeg, RAW and xmp files will appear as a single entity).
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
59
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
60 * Selectable exif auto-rotation of images.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
61
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
62
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
63 * Single click file copy or move to pre-defined folders - with undo feature.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
64 * Drag and drop.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
65
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
66 * Collections.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
67
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
68 * support for stereoscopic images
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
69 * input: side-by-side (JPS) and MPO format
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
70 * output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
71
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
72 * Viewing raster and vector images, in the following formats:
2650
7ebdebe64f75 Fix #163: Remove redundant file types
Colin Clark <colin.clark@cclark.uk>
parents: 2642
diff changeset
73 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.
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
74
2673
bef1f1a91df9 Fix #541: Showing existing, or maybe generating thumbnails for MP4 and WEBM
Tomasz Golinski <tomaszg@math.uwb.edu.pl>
parents: 2668
diff changeset
75 * Preview and thumbnails of video clips can be displayed. Clips can be run via a defined external program.
bef1f1a91df9 Fix #541: Showing existing, or maybe generating thumbnails for MP4 and WEBM
Tomasz Golinski <tomaszg@math.uwb.edu.pl>
parents: 2668
diff changeset
76
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
77 * 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.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
78
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
79 * Pan(orama) view displays image thumbnails in calendar, grid, folder and other layouts.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
80 * All available metadata and Exif/IPTC/XMP data can be displayed, as well as colour histograms and assigned tags, keywords and comments.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
81
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
82 * Selectable image overlay display box - can contain any text or meta-data.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
83
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
84 * Panels can be docked or floating.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
85
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
86 * 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.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
87
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
88 * 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.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
89
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
90 * 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.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
91
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
92 * Geeqie supports applying the colour profile embedded in an image along with the system monitor profile (or a user-specified monitor profile).
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
93
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
94 * Geeqie sessions can be remotely controlled from external software, so it can be used as an image-viewer component of a bigger application.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
95
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
96 * 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.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
97 * Images may be given a rating value (also known as a "star rating").
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
98
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
99 * 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.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
100
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
101 ## Downloading
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
102
2865
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
103 Geeqie is available as a package with some distributions, however Geeqie is stable and you may compile the latest version from sources.
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
104
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
105 There are two scripts which will download and compile the sources for you.
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
106
2865
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
107 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.
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
108 To get the script, from the command line type:<br/><br/>
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
109 `wget https://raw.githubusercontent.com/pixlsus/Scripts/master/build-geeqie`
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
110
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
111 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.
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
112 To get the script, from the command line type:<br/><br/>
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
113 `wget https://raw.githubusercontent.com/BestImageViewer/geeqie/master/web/geeqie-install-debian.sh`
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
114
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
115
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
116 If you wish to compile the sources yourself you may download the latest version (if you have installed git) from here:
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
117
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
118 Either: `git clone git://www.geeqie.org/geeqie.git`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
119
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
120 Or: `git clone http://www.geeqie.org/git/geeqie.git`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
121
2865
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
122 ## Manual Installation
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
123
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
124 List compile options: `./autogen.sh --help`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
125
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
126 Common options:
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
127 `./autogen.sh --disable-gtk3`,
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
128
2618
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
129 Compilation: `./autogen.sh [options]; make -j<no. of cpu cores> `
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
130
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
131 Install: `[sudo] make install`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
132
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
133 Removal: `[sudo] make uninstall`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
134
2618
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
135 #### Note:
2658
b3f34f91ac4d Update web help file and other docs
Colin Clark <colin.clark@cclark.uk>
parents: 2650
diff changeset
136 The zip and gzip files at geeqie.org and GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
2618
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
137
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
138 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.
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
139
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
140 However if you leave the folder intact, whenever new features or patches are available, execute:
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
141
2667
07fe0499a310 Fix #542: About window shows old commit
Colin Clark <colin.clark@cclark.uk>
parents: 2658
diff changeset
142 `git pull; sudo make uninstall; sudo make maintainer-clean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
2618
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
143
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
144 Only the changed sources are downloaded, which makes this a quick operation.
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
145
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
146 Your configuration file, history file and desktop files are not affected by this process.
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
147
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
148
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
149
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
150 ## Notes and changes for the latest release
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
151
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
152 See the NEWS file in the installation folder, or [Geeqie News at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/NEWS)
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
153
2658
b3f34f91ac4d Update web help file and other docs
Colin Clark <colin.clark@cclark.uk>
parents: 2650
diff changeset
154 And either the ChangeLog file or [Geeqie ChangeLog](http://geeqie.org/cgi-bin/gitweb.cgi?p=geeqie.git;a=shortlog)
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
155
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
156
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
157 ## Requirements
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
158
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
159 ### Required libraries:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
160 GTK+ 3.00
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
161 www.gtk.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
162 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
163 disable with configure option: --disable-gtk3
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
164 or
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
165 GTK+ 2.20
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
166 disabled by default when GTK+3 libraries are found.
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
167 enable with configure option: --disable-gtk3
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
168 optional items map display and GPU acceleration are not available
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
169 with GTK2
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
170
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
171 Note: GTK+3 is still somehow experimental. It is needed for some
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
172 features but we have several complains about the GTK+3 usability.
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
173
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
174 So if you need a stable version, you are advised to compile it
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
175 with GTK+2. If you want to play with the cool new features, use
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
176 GTK+3.
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
177
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
178 ### Optional libraries:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
179 lcms2 2.0
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
180 or
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
181 lcms 1.14
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
182 www.littlecms.com
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
183 for color management support
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
184 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
185 disable with configure option: --disable-lcms
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
186
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
187 exiv2 0.11
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
188 www.exiv2.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
189 for enhanced exif support
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
190 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
191 disable with configure option: --disable-exiv2
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
192
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
193 lirc
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
194 www.lirc.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
195 for remote control support
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
196 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
197 disable with configure option: --disable-lirc
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
198
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
199 libchamplain-gtk 0.12
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
200 libchamplain 0.12
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
201 libclutter 1.0
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
202 wiki.gnome.org/Projects/libchamplain
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
203 for map display
2594
6af5b8db48bb Update documentation for autogen.sh options
Colin Clark <colin.clark@cclark.uk>
parents: 2578
diff changeset
204 enabled by default
6af5b8db48bb Update documentation for autogen.sh options
Colin Clark <colin.clark@cclark.uk>
parents: 2578
diff changeset
205 disable with configure option: --disable-map
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
206
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
207 libclutter 1.0
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
208 www.clutter-project.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
209 for GPU acceleration (a check-box on Preferences/Image must also be ticked)
2594
6af5b8db48bb Update documentation for autogen.sh options
Colin Clark <colin.clark@cclark.uk>
parents: 2578
diff changeset
210 enabled by default
6af5b8db48bb Update documentation for autogen.sh options
Colin Clark <colin.clark@cclark.uk>
parents: 2578
diff changeset
211 disable with configure option: --disable-gpu-accel
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
212 explicitly disabling will also disable the map feature
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
213
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
214 lua 5.1
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
215 www.lua.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
216 support for lua scripting
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
217 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
218 disable with configure option: --disable-lua
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
219
2668
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
220 librsvg2-common
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
221 for displaying .svg images
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
222
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
223 libwmf0.2-7-gtk
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
224 for displaying .wmf images
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
225
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
226 (see also "Additional pixbuf loaders" in the References section of the Help file)
e2f68d2ff2a0 Additional pixbuf loader documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2667
diff changeset
227
2573
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
228 awk
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
229 when running Geeqie, to use the geo-decode function
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
230
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
231 markdown
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
232 when compiling Geeqie, to create this file in html format
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
233
2747
99245ee344a9 Update ffmpegthumbnailer library version
Colin Clark <colin.clark@cclark.uk>
parents: 2691
diff changeset
234 libffmpegthumbnailer 2.1.0
2673
bef1f1a91df9 Fix #541: Showing existing, or maybe generating thumbnails for MP4 and WEBM
Tomasz Golinski <tomaszg@math.uwb.edu.pl>
parents: 2668
diff changeset
235 https://github.com/dirkvdb/ffmpegthumbnailer
bef1f1a91df9 Fix #541: Showing existing, or maybe generating thumbnails for MP4 and WEBM
Tomasz Golinski <tomaszg@math.uwb.edu.pl>
parents: 2668
diff changeset
236 for thumbnailing camera video clips
bef1f1a91df9 Fix #541: Showing existing, or maybe generating thumbnails for MP4 and WEBM
Tomasz Golinski <tomaszg@math.uwb.edu.pl>
parents: 2668
diff changeset
237 disable with configure option: --disable-ffmpegthumbnailer
2573
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
238
2799
ea4163f0c769 Ref #332: include pdf-view
Colin Clark <colin.clark@cclark.uk>
parents: 2747
diff changeset
239 libpoppler-glib-dev 0.62
ea4163f0c769 Ref #332: include pdf-view
Colin Clark <colin.clark@cclark.uk>
parents: 2747
diff changeset
240 for displaying pdf files
ea4163f0c769 Ref #332: include pdf-view
Colin Clark <colin.clark@cclark.uk>
parents: 2747
diff changeset
241 disable with configure option: --disable-pdf
ea4163f0c769 Ref #332: include pdf-view
Colin Clark <colin.clark@cclark.uk>
parents: 2747
diff changeset
242
2821
0c4659cd6d32 Remove ZoneDetect .bin file from repository
Colin Clark <colin.clark@cclark.uk>
parents: 2804
diff changeset
243 ZoneDetect
0c4659cd6d32 Remove ZoneDetect .bin file from repository
Colin Clark <colin.clark@cclark.uk>
parents: 2804
diff changeset
244 For displaying timezone and UTC/DST time offset
0c4659cd6d32 Remove ZoneDetect .bin file from repository
Colin Clark <colin.clark@cclark.uk>
parents: 2804
diff changeset
245 Download file:
0c4659cd6d32 Remove ZoneDetect .bin file from repository
Colin Clark <colin.clark@cclark.uk>
parents: 2804
diff changeset
246 https://github.com/BertoldVdb/ZoneDetect/raw/master/database/timezone21.bin
0c4659cd6d32 Remove ZoneDetect .bin file from repository
Colin Clark <colin.clark@cclark.uk>
parents: 2804
diff changeset
247 and copy to the location of the Geeqie ancilliary files, which is usually:
0c4659cd6d32 Remove ZoneDetect .bin file from repository
Colin Clark <colin.clark@cclark.uk>
parents: 2804
diff changeset
248 /usr/local/lib/geeqie/
0c4659cd6d32 Remove ZoneDetect .bin file from repository
Colin Clark <colin.clark@cclark.uk>
parents: 2804
diff changeset
249
2865
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
250 libimage-exiftool-perl
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
251 For the jpeg extraction plugin
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
252
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
253 liblcms2-utils
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
254 For the command-line tool jpgicc, used by the jpeg extraction plugin
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
255
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
256 ImageMagick
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
257 exiftran
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
258 gphoto2
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
259 ufraw
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
260 exiv2
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
261 Additional command-line tools for various operations
cb5326e72117 Ref #631: Compilation script for all distributions
Colin Clark <colin.clark@cclark.uk>
parents: 2821
diff changeset
262
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
263 ### Code hackers:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
264
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
265 If you plan on making any major changes to the code that will be offered for
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
266 inclusion to the main source, please contact us first - so that we can avoid
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
267 duplication of effort.
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
268 The Geeqie Team
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
269
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
270 ### Known bugs:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
271
2573
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
272 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>