Mercurial > hg > forks > geeqie

annotate README.md @ 2618:9e29be68f634

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update installation instructions
author Colin Clark <colin.clark@cclark.uk>
date Wed, 27 Sep 2017 17:43:52 +0100
parents 6af5b8db48bb
children df4a5498898f
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 ## ##
2573
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
4 ## Copyright (C) 2008 - 2017 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
2578
ae0550a148c5 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2577
diff changeset
24 Please send any questions, problems or suggestions to the [mailing list](mailto:geeqie-devel@lists.sourceforge.net) or
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
25 open an issue on [Geeqie at GitHub](https://github.com/BestImageViewer/geeqie/issues).
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
26
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
27 Subscribe to the mailing list [here](https://lists.sourceforge.net/lists/listinfo/geeqie-devel).
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:
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
73 3FR, ANI, APM, ARW, BMP, CR2, CRW, CUR, DCR, DNG, ERF, GIF, ICNS, ICO, JPE/JPEG/JPG, JP2/JPC/JPX/J2K/JPF, JPS, K25, KDC, MEF, MPO, MOS, MRW, NEF, ORF, PCX, PEF, PBM/PGM/PNM/PPM, PNG, PTX, QIF/QTIF (QuickTime Image Format), R3D, RAF, RAS (Sun raster), RAW, SR2, SRF, SVG/SVGZ, TGA/TARGA, TIF/TIFF, WBMP, WMF, X3F, XBM, XPM. Animated GIFs are supported.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
74
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
75 * 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
76
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
77 * 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
78 * 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
79
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
80 * 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
81
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
82 * Panels can be docked or floating.
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 * 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
85
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
86 * 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
87
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
88 * 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
89
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
90 * 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
91
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
92 * 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
93
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
94 * 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
95 * 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
96
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
97 * 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
98
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
99 ## Downloading
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 Geeqie is available as a package with some distributions.
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
102
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
103 The source tar of the latest formal release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz>
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
104
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
105 However Geeqie is stable, and you may download the latest version (if you have installed git) from here:
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
106
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
107 Either: `git clone git://www.geeqie.org/geeqie.git`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
108
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
109 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
110
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
111
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
112 ## Installation
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
113
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
114 Update secondary help documents (optional - requires use of git):
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
115 `./gen_changelog.sh ; markdown README.md > README.html`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
116
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
117 List compile options: `./autogen.sh --help`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
118
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
119 Common options:
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
120 `./autogen.sh --disable-gtk3`,
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
121
2618
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
122 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
123
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
124 Install: `[sudo] make install`
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 Removal: `[sudo] make uninstall`
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
127
2618
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
128 #### Note:
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
129 The zip files at GitHub contain only the sources - they cannot, by themselves, be used to install Geeqie.
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
130
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
131 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
132
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
133 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
134
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
135 `git pull; sudo make uninstall; sudo make distclean; ./autogen.sh; make -j<no. of cpu cores>; sudo make install`
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
136
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
137 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
138
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
139 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
140
9e29be68f634 Update installation instructions
Colin Clark <colin.clark@cclark.uk>
parents: 2594
diff changeset
141
2577
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
142
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
143 ## Notes and changes for the latest release
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
144
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
145 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
146
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
147 And either the ChangeLog file or [Geeqie ChangeLog at GitHub](https://github.com/BestImageViewer/geeqie/blob/master/ChangeLog)
283e7cdf4ab2 Ref #226: Update website
Colin Clark <colin.clark@cclark.uk>
parents: 2573
diff changeset
148
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
149
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
150 ## Requirements
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
151
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
152 ### Required libraries:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
153 GTK+ 3.00
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
154 www.gtk.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
155 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
156 disable with configure option: --disable-gtk3
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
157 or
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
158 GTK+ 2.20
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
159 disabled by default when GTK+3 libraries are found.
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
160 enable with configure option: --disable-gtk3
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
161 optional items map display and GPU acceleration are not available
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
162 with GTK2
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
163
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
164 Note: GTK+3 is still somehow experimental. It is needed for some
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
165 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
166
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
167 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
168 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
169 GTK+3.
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 ### Optional libraries:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
172 lcms2 2.0
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
173 or
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
174 lcms 1.14
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
175 www.littlecms.com
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
176 for color management support
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
177 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
178 disable with configure option: --disable-lcms
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
179
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
180 exiv2 0.11
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
181 www.exiv2.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
182 for enhanced exif support
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
183 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
184 disable with configure option: --disable-exiv2
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
185
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
186 lirc
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
187 www.lirc.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
188 for remote control support
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
189 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
190 disable with configure option: --disable-lirc
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
191
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
192 libchamplain-gtk 0.12
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
193 libchamplain 0.12
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
194 libclutter 1.0
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
195 wiki.gnome.org/Projects/libchamplain
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
196 for map display
2594
6af5b8db48bb Update documentation for autogen.sh options
Colin Clark <colin.clark@cclark.uk>
parents: 2578
diff changeset
197 enabled by default
6af5b8db48bb Update documentation for autogen.sh options
Colin Clark <colin.clark@cclark.uk>
parents: 2578
diff changeset
198 disable with configure option: --disable-map
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
199
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
200 libclutter 1.0
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
201 www.clutter-project.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
202 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
203 enabled by default
6af5b8db48bb Update documentation for autogen.sh options
Colin Clark <colin.clark@cclark.uk>
parents: 2578
diff changeset
204 disable with configure option: --disable-gpu-accel
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
205 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
206
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
207 lua 5.1
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
208 www.lua.org
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
209 support for lua scripting
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
210 enabled by default
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
211 disable with configure option: --disable-lua
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
212
2573
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
213 awk
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
214 when running Geeqie, to use the geo-decode function
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
215
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
216 markdown
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
217 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
218
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
219
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
220 ### Code hackers:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
221
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
222 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
223 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
224 duplication of effort.
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
225 The Geeqie Team
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
226
2515
1011f7b73067 Better Markdown
Klaus Ethgen <Klaus@Ethgen.de>
parents: 2513
diff changeset
227 ### Known bugs:
2537
1981e764e760 Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff changeset
228
2573
3e5919841759 Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents: 2542
diff changeset
229 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues>