This is the digiKam Software Compilation <http://www.digikam.org>

- ABOUT --------------------------------------------------------------------

digiKam is an advanced digital photo management application for KDE, which makes importing and organizing digital photos a 'snap'.

This is a super-repository that helps to download and compile digiKam with all components developed by digiKam team.

- DEPENDENCIES -------------------------------------------------------------

* To checkout all source code:

- PERL     <http://www.perl.org>
- GIT      <http://git-scm.com>

* To process translations files (optional)

- RUBY     <http://www.ruby-lang.org>             (to extract translations files from KDE repositories)
- Gettext  <https://www.gnu.org/software/gettext> (including Msgfmt)

* To download all needed git repositories, execute download script like this: perl ./download-repos

* Important: by default only compnents required for packaging are downloaded. To populate developers
  only components, set $GITSLAVE environnement variable before to run ./download-repos script, like this:

  export GITSLAVE=.gitslave.devel

* To compile all source code, take a look on each README files to resolve dependencies.

- COMPONENTS ---------------------------------------------------------------

Redmine project pages can be found here :

* This super repository:

digiKam SC       : https://projects.kde.org/projects/extragear/graphics/digikam/digikam-software-compilation

Code base:

digiKam          : https://projects.kde.org/projects/extragear/graphics/digikam
Kipi-plugins     : https://projects.kde.org/projects/extragear/graphics/kipi-plugins

* Extra components managed by this Software Compilation for developers only are listed below:

libkipi          : https://projects.kde.org/projects/kde/kdegraphics/libs/libkipi
libksane         : https://projects.kde.org/projects/kde/kdegraphics/libs/libksane
libmediawiki     : https://projects.kde.org/projects/extragear/libs/libmediawiki
libkvkontatke    : https://projects.kde.org/projects/extragear/libs/libkvkontatke

* Documentations:

digiKam DOC      : https://projects.kde.org/projects/extragear/graphics/digikam/digikam-doc
Kipi-plugins DOC : https://projects.kde.org/projects/extragear/graphics/kipi-plugins/kipi-plugins-doc

- NOTES ---------------------------------------------------------------------

If you are a developer with push access to the repositories, it is strongly recommended
to use the "kde:" prefix and let git use the read-only mirrors for pulling.

If you did not clone this repository (digikam-software-compilation) from "kde:", do it again:
    git config --global url.git://anongit.kde.org/.insteadof kde:
    git config --global url.ssh://git@git.kde.org/.pushinsteadof kde:
    git clone kde:digikam-software-compilation

See below an example of .gitconfig file working with a developer account :

[url "git://anongit.kde.org/"]
        insteadof = kde://

[url "git@git.kde.org:"]
        pushinsteadof = kde://

[url "ssh://git@git.kde.org/"]
        pushinsteadof = kde://

[alias]
        up = pull --rebase -v --stat
        ci = commit -a -v
[core]
        editor = mcedit

[user]
        name = my name
        email = my email

[push]
        default = tracking

[color]
        # turn on color
        diff = auto
        status = auto
        branch = auto
        interactive = auto
        ui = auto

[color "branch"]
        current = green bold
        local = green
        remote = red bold

[color "diff"]
        meta = yellow bold
        frag = magenta bold
        old = red bold
        new = green bold

[color "status"]
        added = green bold
        changed = yellow bold
        untracked = red

[color "sh"]
        branch = yellow                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             [color "sh"]                                                                                                                                                                                                       

- CMAKE OPTIONS --------------------------------------------------------------

Packaging options:

"-DDIGIKAMSC_COMPILE_DOC=ON"               Build handbook files.
"-DDIGIKAMSC_CHECKOUT_PO=ON"               Extract po files from KDE repositories using ./project/release/fetch_l10n.rb Ruby script.
"-DDIGIKAMSC_COMPILE_PO=ON"                Build translations files. It require to checkout po files before from KDE repositories.

Developers only options:

"-DBUILD_TESTING=ON"                       Build tests code.
"-DDIGIKAMSC_COMPILE_LIBKIPI=OFF"          Force to use local libkipi instead version installed on your computer.
"-DDIGIKAMSC_COMPILE_LIBKFACE=OFF"         Force to use local libkface instead version installed on your computer.
"-DDIGIKAMSC_COMPILE_LIBKSANE=OFF"         Force to use local libksane instead version installed on your computer.
"-DDIGIKAMSC_COMPILE_LIBMEDIAWIKI=OFF"     Force to use local libmediawiki instead version installed on your computer.
"-DDIGIKAMSC_COMPILE_LIBKVKONTAKE=OFF"     Force to use local libkvkontakte instead version installed on your computer.

Look README files from sub-dirs for more options available to configure compilation environnement.

To configure project with CMake, use dedicated "bootstrap" script for your platform.

------------
digiKam team
