Mercurial > hg > forks > geeqie
annotate README.md @ 2573:3e5919841759
Update secondary user documentation
Use standard gtk_about_dialog for Help About
Move contributers to AUTHORS file so that they appear in the Credits
dialog
Change gen_changelog.sh to create ChangeLog.html
Include ChangeLog on Help menu
Make presence of README.html and ChangeLog.html mandatory
It would be better to generate above html files from automake.
gtk_about_dialog uses msgid _("translator-credits"), but the translators
do not use it.
author | Colin Clark <colin.clark@cclark.uk> |
---|---|
date | Tue, 08 Aug 2017 19:30:01 +0100 |
parents | 85a4f55d2b33 |
children | 283e7cdf4ab2 |
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 | 15 [![Build Status](https://api.travis-ci.org/BestImageViewer/geeqie.svg?branch=master)](https://travis-ci.org/BestImageViewer/geeqie) |
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 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
18 contact GQview author and the only maintainer. Geeqie projects goal is to move |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
19 the development forward and also integrate the existing patches. |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
20 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
21 Geeqie is currently considered stable. Please report any crash or odd behavior |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
22 to the [mailing list](https://lists.sourceforge.net/lists/listinfo/geeqie-devel) |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
23 and/or to [Github](https://github.com/BestImageViewer/geeqie/issues) |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
24 |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
25 For more info see: <http://www.geeqie.org/> |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
26 |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
27 Please send any question or suggestions to <geeqie-devel@lists.sourceforge.net> or |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
28 open an issue on <https://github.com/BestImageViewer/geeqie/issues> |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
29 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
30 # README contents: |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
31 |
2538 | 32 * Requirements |
33 * Notes and changes for this release | |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
34 * Downloading |
2538 | 35 * Installation |
36 * Description / Features | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
37 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
38 ## Requirements |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
39 |
2515 | 40 ### Required libraries: |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
41 GTK+ 3.00 |
2515 | 42 www.gtk.org |
43 enabled by default | |
44 disable with configure option: --disable-gtk3 | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
45 or |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
46 GTK+ 2.20 |
2515 | 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 | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
51 |
2515 | 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. | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
54 |
2515 | 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. | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
58 |
2515 | 59 ### Optional libraries: |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
60 lcms2 2.0 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
61 or |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
62 lcms 1.14 |
2515 | 63 www.littlecms.com |
64 for color management support | |
65 enabled by default | |
66 disable with configure option: --disable-lcms | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
67 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
68 exiv2 0.11 |
2515 | 69 www.exiv2.org |
70 for enhanced exif support | |
71 enabled by default | |
72 disable with configure option: --disable-exiv2 | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
73 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
74 lirc |
2515 | 75 www.lirc.org |
76 for remote control support | |
77 enabled by default | |
78 disable with configure option: --disable-lirc | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
79 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
80 libchamplain-gtk 0.12 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
81 libchamplain 0.12 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
82 libclutter 1.0 |
2515 | 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 | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
88 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
89 libclutter 1.0 |
2515 | 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 | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
95 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
96 lua 5.1 |
2515 | 97 www.lua.org |
98 support for lua scripting | |
99 enabled by default | |
100 disable with configure option: --disable-lua | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
101 |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
102 awk |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
103 when running Geeqie, to use the geo-decode function |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
104 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
105 markdown |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
106 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
|
107 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
108 |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
109 ## Notes and changes for this release [section:release_notes] |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
110 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
111 See NEWS file. |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
112 |
2515 | 113 ### Code hackers: |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
114 |
2515 | 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. | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
118 The Geeqie Team |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
119 |
2515 | 120 ### Known bugs: |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
121 |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
122 See the Geeqie Bug Tracker at <https://github.com/BestImageViewer/geeqie/issues> |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
123 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
124 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
125 ## Downloading |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
126 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
127 Geeqie is available as a package with some distributions. |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
128 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
129 The source tar of the latest release may be downloaded: <http://geeqie.org/geeqie-1.3.tar.xz> |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
130 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
131 To download the sources of the latest commits you must have installed git: |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
132 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
133 Either: `git clone git://www.geeqie.org/geeqie.git` |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
134 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
135 Or: `git clone http://www.geeqie.org/git/geeqie.git` |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
136 |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
137 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
138 ## Installation |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
139 |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
140 Update secondary help documents (optional - requires use of git): |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
141 `./gen_changelog.sh ; markdown README.md > README.html` |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
142 |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
143 Show compile options: `./autogen.sh --help` |
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
144 |
2515 | 145 Compilation: `./autogen.sh ; make` |
146 | |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
147 General install: `[sudo] make install` |
2515 | 148 |
2573
3e5919841759
Update secondary user documentation
Colin Clark <colin.clark@cclark.uk>
parents:
2542
diff
changeset
|
149 Removal: `[sudo] make uninstall` |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
150 |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
151 ## Description / Features |
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
152 |
2513 | 153 Geeqie is a graphics file viewer. Basic features: |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
154 |
2513 | 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) | |
2537
1981e764e760
Rename README to README.md
J. R. Schmid <jrs+git@weitnahbei.de>
parents:
diff
changeset
|
170 |