1 PhotoQt v1.6 - Copyright (C) 2011-2018, Lukas Spies (Lukas@photoqt.org),
2 License: GPLv2 (or later) -- Website: http://photoqt.org
3--------------------------------------------------------------------
4
5 PhotoQt is a fast and highly configurable image viewer with a simple
6 and nice interface.
7
8
9 DEPENDENCIES
10--------------
11- Qt >= 5.5
12- CMake (needed for building PhotoQt)
13
14> Make sure that you have the required QML modules installed:
15  QtGraphicalEffects, QtMultimedia, QtQuick, QtQuick.Controls,
16  QtQuick.Controls.Styles, QtQuick.Layouts, QtQuick.Window
17
18> Dependencies, that are needed by default, but can be disabled via CMake
19   (see INSTALL section):
20- Exiv2
21- GraphicsMagick
22- LibRaw
23
24> NOTE
25  On some systems you also need the *-dev package for compiling (e.g.
26  exiv2-dev - names can vary slightly depending on your distribution). These
27  files usually can be uninstalled again after compilation is done.
28
29> NOTE
30  Even though GraphicsMagick initially started as a fork of ImageMagick (back in
31  2002), trying to build PhotoQt with ImageMagick wont work!
32
33
34 OPTIONAL DEPENDENCIES
35-----------------------
36- XCFtools - https://github.com/j-jorge/xcftools
37- libqpsd - https://github.com/Code-ReaQtor/libqpsd
38
39> These dependencies are not needed for compiling PhotoQt. However, if they are
40  installed, you can set PhotoQt (via settings) to make use of them for improved
41  XCF/PSD support.
42
43
44 INSTALL
45---------
46
471) mkdir build && cd build/
48
492) cmake ..
50
51     # Note: This installs PhotoQt by default into /usr/local/{bin,share}
52     # To install PhotoQt into another prefix e.g. /usr/{bin,share}, run:
53
54     cmake -DCMAKE_INSTALL_PREFIX=/usr ..
55
56     # PhotoQt makes use of the libraries Exiv2, GraphicsMagick ("gm") and LibRaw.
57     # You can en-/disable them with the following options:
58     # (if you don't specify anything, it asumes a default value of ON)
59
60     -DEXIV2=OFF
61     -DGM=OFF
62     -DRAW=OFF
63
64     # You can combine them in any way you want.
65     # The following option equates to setting the three above options to OFF
66
67     -DQTONLY=ON
68
69     # If CMake aborts with the error that it can't find Exiv2 and/or GraphicsMagick,
70     # and/or LibRaw, but you're certain that the header files are available, then
71     # you can pass their locations to CMake:
72
73     -DMAGICK_LOCATION=/path/to/graphicsmagick
74     -DEXIV2_LOCATION=/path/to/exiv2
75     -DLIBRAW_LOCATION=/path/to/libraw
76
773) make  # This creates an executeable photoqt binary located in the ./build/ folder
78
794) (as root or sudo) make install
80     # This (i) installs the desktop file to share/applications/
81     #      (ii) installs some icons to icons/hicolor/
82     #      (iii) installs the binary to bin/
83     #      (iv) installs the appdata file to share/appdata/
84
85
86 UNINSTALL
87-----------
88 If you want to uninstall PhotoQt, simply run "make uninstall" as root. This removes
89 the desktop file (via xdg-desktop-menu uninstall), the icons, the binary file, and
90 the appdata file. Alternatively you can simply remove all the files manually, that
91 should yield the same result.
92