README.md 6.65 KB
Newer Older
Gilles Caulier's avatar
Gilles Caulier committed
1
![](https://c1.staticflickr.com/1/822/26082076957_5ff0796a99_o.png) digiKam - Professional Photo Management with the Power of Open Source
2

Gilles Caulier's avatar
Gilles Caulier committed
3
[![Build Status](https://build.kde.org/job/Extragear/job/digikam/job/kf5-qt5%20SUSEQt5.12/badge/icon)](https://build.kde.org/job/Extragear/job/digikam/job/kf5-qt5%20SUSEQt5.12/)
4

Gilles Caulier's avatar
Gilles Caulier committed
5
If you are reading this on Github, be aware that this is just a mirror. Our real code repository [is located here](https://invent.kde.org/kde/digikam)
Gilles Caulier's avatar
Gilles Caulier committed
6

Chandra Kant's avatar
Chandra Kant committed
7
Developers, if you want to contribute, see the online [API documentation here](https://www.digikam.org/api)
Gilles Caulier's avatar
Gilles Caulier committed
8

Maik Qualmann's avatar
Maik Qualmann committed
9
# About
10 11 12 13

digiKam is an advanced open-source digital photo management application that runs on Linux, Windows, and MacOS.
The application provides a comprehensive set of tools for importing, managing, editing, and sharing photos and RAW files.

Gilles Caulier's avatar
Gilles Caulier committed
14
[![](https://c1.staticflickr.com/5/4216/35354951072_a034561b5e_c.jpg "Albums View and Image Editor")](https://www.flickr.com/photos/digikam/35354951072/)
15 16 17 18 19

You can use digiKam's import capabilities to easily transfer photos, RAW files, and videos directly from your camera
and external storage devices (SD cards, USB disks, etc.). The application allows you to configure import settings
and rules that process and organize imported items on-the-fly.

Gilles Caulier's avatar
Gilles Caulier committed
20 21
[![](https://c1.staticflickr.com/1/703/32558229094_3d7ec01d3a_c.jpg "Map View displaying rated items and Batch Queue Manager in action")](https://www.flickr.com/photos/digikam/32558229094)

22 23 24 25
digiKam organizes photos, RAW files, and videos into albums. But the application also features powerful tagging
tools that allow you to assign tags, ratings, and labels to photos and raw files. You can then use filtering
functionality to quickly find items that match specific criteria.

Gilles Caulier's avatar
Gilles Caulier committed
26 27
[![](https://c2.staticflickr.com/4/3726/32557269024_ae870b0466_c.jpg "Search items by date rage and Geolocation editor")](https://www.flickr.com/photos/digikam/32557269024)

28 29
In addition to filtering functionality, digiKam features powerful searching capabilities that let you search
the photo library by a wide range of criteria. You can search photos by tags, labels, rating, data, location,
Gilles Caulier's avatar
Gilles Caulier committed
30 31 32 33 34 35
and even specific EXIF, IPTC, or XMP metadata.

[![](https://c1.staticflickr.com/1/306/32217007615_db6f9d116a_c.jpg "Search by Tags with preview mode and Metadata Editor in action")](https://www.flickr.com/photos/digikam/32217007615)

You can also combine several criteria for more advanced searches. digiKam rely on Exiv2 library to handle metadata
tag contents from files to populate the photo library.
36

Gilles Caulier's avatar
Gilles Caulier committed
37
[![](https://c1.staticflickr.com/5/4795/40743725771_0b69dca743_c.jpg "Advanced search tool and video file result played as preview")](https://www.flickr.com/photos/digikam/40743725771)
Gilles Caulier's avatar
Gilles Caulier committed
38

39 40 41
digiKam can handle RAW files, and the application uses the excellent LibRaw library for decoding raw files.
The library is actively maintained and regularly updated to include support for the latest camera models.

Gilles Caulier's avatar
Gilles Caulier committed
42 43
[![](https://c1.staticflickr.com/1/300/31407487553_a14abd0418_c.jpg "Find by items similarity and Light Table in cation to compare side by side")](https://www.flickr.com/photos/digikam/31407487553)

44 45 46 47
The application provides a comprehensive set of editing tools. This includes basic tools for adjusting colors,
cropping, and sharpening as well as advanced tools for, curves adjustment, panorama stitching, and much more.
A special tool based on Lensfun library permit to apply lens corrections automatically on images.

Gilles Caulier's avatar
Gilles Caulier committed
48
[![](https://c1.staticflickr.com/5/4649/40430534662_097b46a270_c.jpg "Panorama tool stiching photo")](https://www.flickr.com/photos/digikam/40474079731)
Gilles Caulier's avatar
Gilles Caulier committed
49

Gilles Caulier's avatar
Gilles Caulier committed
50
Extended functionality in digiKam is implemented via a set of tools, dedicated especially to import and export
Gilles Caulier's avatar
Gilles Caulier committed
51
contents to remote web-services.
52 53 54

digiKam is based in part on the work of the Independent JPEG Group.

Maik Qualmann's avatar
Maik Qualmann committed
55
# Authors
56

Maik Qualmann's avatar
Maik Qualmann committed
57
See [AUTHORS](AUTHORS) file for details.
58

Maik Qualmann's avatar
Maik Qualmann committed
59
# Related URLs
60 61 62

http://www.digikam.org

Maik Qualmann's avatar
Maik Qualmann committed
63
# Contact
64 65 66 67 68 69 70 71 72

If you have questions, comments, suggestions to make do email at :

digikam-users@kde.org

If you want contribute to digiKam developments do email at :

digikam-devel@kde.org

Gilles Caulier's avatar
Gilles Caulier committed
73
IRC channel from irc.freenode.org server: [#digikam](http://webchat.freenode.net/?channels=digikam)
74

Maik Qualmann's avatar
Maik Qualmann committed
75
# Bug reports
76

Gilles Caulier's avatar
Gilles Caulier committed
77 78
IMPORTANT : the bug reports and wishlist entries are hosted by the Bugzilla
system which can be reached from the standard Help menu of digiKam.
79 80 81 82 83 84
A mail will automatically be sent to the digiKam development mailing list.
There is no need to contact directly the digiKam mailing list for a bug report
or a devel wish.

The current bugs and devel wishes reported to the bugzilla servers can be seen at these urls :

Maik Qualmann's avatar
Maik Qualmann committed
85
* [digiKam](http://bugs.kde.org/buglist.cgi?product=digikam&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED)
86 87 88

Extra Bugzilla servers for shared libs used by digiKam :

Gilles Caulier's avatar
Gilles Caulier committed
89
* [LibRaw library](https://github.com/LibRaw/LibRaw/issues)
90
* [Lensfun library](https://github.com/lensfun/lensfun/issues)
Maik Qualmann's avatar
Maik Qualmann committed
91
* [GPhoto2 library](http://gphoto.org/bugs)
Gilles Caulier's avatar
Gilles Caulier committed
92
* [Exiv2 library](https://github.com/Exiv2/exiv2/issues)
Maik Qualmann's avatar
Maik Qualmann committed
93
* [QtAV library](https://github.com/wang-bin/QtAV/issues)
94

Gilles Caulier's avatar
Gilles Caulier committed
95
# External Dependencies
96

Gilles Caulier's avatar
Gilles Caulier committed
97
See the [online Dependencies list](https://www.digikam.org/api/index.html#externaldeps) for details.
98

Gilles Caulier's avatar
Gilles Caulier committed
99
# Cmake Configuration
100

Gilles Caulier's avatar
Gilles Caulier committed
101
See the [online Configuration rules](https://www.digikam.org/api/index.html#cmakeoptions) for details.
102

Maik Qualmann's avatar
Maik Qualmann committed
103
# Installation
104 105 106

In order to compile, just use something like that:

Maik Qualmann's avatar
Maik Qualmann committed
107 108 109 110 111 112
    export VERBOSE=1
    export QTDIR=/usr/lib/qt5
    export PATH=$QTDIR/bin:$PATH
    cmake .
    make
    sudo make install
113 114 115

Usual CMake options :

Gilles Caulier's avatar
Gilles Caulier committed
116 117
* `-DCMAKE_INSTALL_PREFIX` : decide where the program will be install on your computer.
* `-DCMAKE_BUILD_TYPE`     : decide which type of build you want. You can chose between:
118 119 120 121 122
  * `debugfull`.     : for hacking. Include all debug information.
  * `debug`.
  * `profile`.
  * `relwithdebinfo` : default. use gcc `-O2` `-g` options.
  * `release`        : generate stripped and optimized bin files. For packaging.
123 124 125

Compared to old autoconf options:

126 127
* `cmake . -DCMAKE_BUILD_TYPE=debugfull` is equivalent to `./configure --enable-debug=full`
* `cmake . -DCMAKE_INSTALL_PREFIX=/usr`  is equivalent to `./configure --prefix=/usr`
128

Gilles Caulier's avatar
Gilles Caulier committed
129
More details can be found [at this url](http://techbase.kde.org/Development/Tutorials/CMake#Environment_Variables)
130

Maik Qualmann's avatar
Maik Qualmann committed
131
Note: To know KDE install path on your computer, use `kf5-config --prefix` command line like this (with full debug object enabled):
132

133
* `cmake . -DCMAKE_BUILD_TYPE=debugfull -DCMAKE_INSTALL_PREFIX=$(kf5-config --prefix)`
134

Maik Qualmann's avatar
Maik Qualmann committed
135
# Donate Money
136 137 138 139

If you love digiKam, you can help developers to buy new photo devices to test
and implement new features. Thanks in advance for your generous donations.

Gilles Caulier's avatar
Gilles Caulier committed
140
For more information, look [at this url](https://www.digikam.org/donate/)