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