Skip to content

Commit eff44ea

Browse files
mowglimowgli
committed
Reformat and reword README
1 parent aafc9ec commit eff44ea

File tree

1 file changed

+66
-55
lines changed

1 file changed

+66
-55
lines changed

‎README‎

Lines changed: 66 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
###################################################################
2-
## Geeqie x.x ##
3-
## ##
4-
## Copyright (C) 2008 - 2016 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-
###################################################################
1+
###################################################################
2+
## Geeqie x.x ##
3+
## ##
4+
## Copyright (C) 2008 - 2016 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+
###################################################################
1212

1313
This is Geeqie, a successor of GQview.
1414

1515
Geeqie has been forked from GQview project, because it was not possible to
16-
contact gqview author and the only maintainer. Geeqie projects goal is to move
16+
contact GQview author and the only maintainer. Geeqie projects goal is to move
1717
the development forward and also integrate the existing patches.
1818

1919
Geeqie is currently considered stable. Please report any crash or odd behavior
20-
to the mailing list: https://lists.sourceforge.net/lists/listinfo/geeqie-devel
20+
to the [mailing list](https://lists.sourceforge.net/lists/listinfo/geeqie-devel)
21+
and/or to [Github](https://github.com/BestImageViewer/geeqie/issues)
2122

22-
For more info see:
23-
http://www.geeqie.org/
23+
For more info see: http://www.geeqie.org/
2424

2525
Please send any question or suggestions to [email protected] or
2626
open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
2727

28-
======== README contents:
28+
# README contents:
2929

3030
* Requirements
3131
* Notes and changes for this release
@@ -37,7 +37,7 @@ open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
3737
* Translation status
3838
* Credits
3939

40-
======== Requirements
40+
## Requirements
4141

4242
Required libraries:
4343
GTK+ 3.00
@@ -46,10 +46,17 @@ open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
4646
disable with configure option: --disable-gtk3
4747
or
4848
GTK+ 2.20
49-
disabled by default
49+
disabled by default when GTK+3 libraries are found.
5050
enable with configure option: --disable-gtk3
51-
optional items map display and GPU acceleration
52-
are not available with GTK2
51+
optional items map display and GPU acceleration are not available
52+
with GTK2
53+
54+
Note: GTK+3 is still somehow experimental. It is needed for some
55+
features but we have several complains about the GTK+3 usability.
56+
57+
So if you need a stable version, you are advised to compile it
58+
with GTK+2. If you want to play with the cool new features, use
59+
GTK+3.
5360

5461
Optional libraries:
5562
lcms2 2.0
@@ -94,11 +101,10 @@ open an issue on Github (https://github.com/BestImageViewer/geeqie/issues)
94101
enabled by default
95102
disable with configure option: --disable-lua
96103

97-
======== Notes and changes for this release [section:release_notes]
104+
## Notes and changes for this release [section:release_notes]
98105

99106
See NEWS file.
100107

101-
102108
Code hackers:
103109

104110
If you plan on making any major changes to the code that will be offered for
@@ -108,15 +114,15 @@ See NEWS file.
108114

109115
Known bugs:
110116

111-
see the Geeqie Bug Tracker at TODO file.
117+
See the Geeqie Bug Tracker at TODO file.
112118

113-
======== Installation
119+
## Installation
114120

115121
Compilation: ./autogen.sh ; make
116122
General install: make install
117123
Removal: make uninstall
118124

119-
======== Description / Features
125+
## Description / Features
120126

121127
Geeqie is a graphics file viewer. Basic features:
122128

@@ -131,17 +137,16 @@ See NEWS file.
131137
- Collections.
132138
- Comparison of images to find duplicates by name, size, date,
133139
dimensions, or image content similarity.
140+
- Rotation invariant detection
134141
- EXIF support.
135-
136-
Geeqie 1.1:
137142
- support for stereoscopic images
138143
- input: side-by-side (JPS) and MPO format
139144
- output: single image, anaglyph, SBS, mirror, SBS half size (3DTV)
140145

141-
======== Documentation (brief) [section:documentation]
146+
## Documentation (brief) [section:documentation]
142147

143-
This sections lists default hotkeys. Most of the hotkeys can be redefined
144-
in the Preferences dialog.
148+
This sections lists default hotkeys. Most of the hotkeys can be redefined in the
149+
Preferences dialog.
145150

146151
Keyboard commands:
147152
[PageDown], [Keypad PageDown] next image
@@ -297,27 +302,26 @@ in the Preferences dialog.
297302
Wheel up/down + [Shift] scroll image up/down
298303
Wheel up/down + [Control] zoom image in/out
299304

300-
301-
======== Editor command macros [section:editors]
305+
## Editor command macros [section:editors]
302306

303307
Editors are configured via standard desktop files.
304308

305-
306-
======== Overlay Info [section:overlay]
309+
## Overlay Info [section:overlay]
307310

308311
Overlay info format string syntax is: %tag[:max_length][:extra]%
309312

310-
%name% Filename of the picture.
311-
%collection% Name of the collection
312-
%number% Current number of image in the list
313-
%total% Total number of images
314-
%date% File date
315-
%size% File size
316-
%width% Image width
317-
%height% Image height
318-
%res% Image resolution
319-
%keywords% Image keywords from metadata
320-
%comment% Image comment from metadata
313+
%name% Filename of the picture.
314+
%collection% Name of the collection
315+
%number% Current number of image in the list
316+
%total% Total number of images
317+
%date% File date
318+
%size% File size
319+
%width% Image width
320+
%height% Image height
321+
%res% Image resolution
322+
%keywords% Image keywords from metadata
323+
%comment% Image comment from metadata
324+
%lua/file.lua/% Lua functionality
321325

322326
To access exif data use the exif name:
323327
%Exif.Photo.DateTimeOriginal% Date of the original shot
@@ -339,8 +343,8 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
339343
formatted.GPSAltitude GPS altitude
340344

341345
You can limit the length of displayed data using :number notation:
342-
%formatted.Camera:20% will truncate the displayed data to 20 characters
343-
and will add 3 dots at the end to denote the truncation.
346+
%formatted.Camera:20% will truncate the displayed data to 20 characters and
347+
will add 3 dots at the end to denote the truncation.
344348

345349
If two or more variables are connected with the |-sign, it prints available
346350
variables with a separator:
@@ -350,14 +354,13 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
350354
or
351355
"1/200 - 80 mm" if there's no ISO information in the Exif data.
352356

353-
If a line is empty, it is removed.
354-
This allows one to add lines that totally disappear when no data is available.
357+
If a line is empty, it is removed. This allows one to add lines that totally
358+
disappear when no data is available.
355359

356-
Extra string uses special character '*' to mark the position of the data.
357-
If no '*' is present, then extra string is just appended to data.
358-
Any "\n" is replaced by a newline on display.
359-
Pango mark up is accepted in left and right parts.
360-
If data is empty, nothing will be displayed.
360+
Extra string uses special character '*' to mark the position of the data. If
361+
no '*' is present, then extra string is just appended to data. Any "\n" is
362+
replaced by a newline on display. Pango mark up is accepted in left and right
363+
parts. If data is empty, nothing will be displayed.
361364

362365
Examples:
363366
"%name:<i>*</i>\n%" -> name is displayed in italics ended with a newline
@@ -366,14 +369,15 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
366369
"%collection: Collection <b>*</b>\n%" -> display collection name in bold prefixed by
367370
"Collection " and a newline is appended
368371

369-
======== Credits [section:credits]
372+
## Credits [section:credits]
370373

371374
Translations:
372375

373376
Grzegorz Kowal <[email protected]>
374377
Zbigniew Chyla <[email protected]>
375378
Emil Nowak <[email protected]>
376379
Wit Wilinski <[email protected]>
380+
Tomasz Golinski <[email protected]>
377381
for Polish translation
378382

379383
Christopher R. Gabriel <[email protected]>
@@ -404,6 +408,7 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
404408
Kam Tik <[email protected]>
405409
Abel Cheung <[email protected]>
406410
S.J. Luo <[email protected]>
411+
Levin <[email protected]>
407412
for Traditional Chinese (Big5) translation
408413

409414
Junichi Uekawa <[email protected]>
@@ -501,6 +506,9 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
501506
Antonio C. Codazzi <[email protected]>
502507
for Esperanto translation
503508

509+
Nikos Papadopoulos
510+
for Greek translation
511+
504512
Fixes, additions, and patches:
505513

506514
Eric Swalens
@@ -551,5 +559,8 @@ Overlay info format string syntax is: %tag[:max_length][:extra]%
551559
Colin Clark <[email protected]>
552560
for GPS map integration and more
553561

562+
Colin Clark <[email protected]>
563+
for GPS map support and more
564+
554565
And...
555566
Thanks to the users for finding Geeqie useful.

0 commit comments

Comments
 (0)