-------------------
Installing Kaffeine
-------------------

Prerequisites
=============

The following tools are needed to build Kaffeine:
* GNU c++
* GNU make
* cmake >= 2.8
* cmake ECM (extra-cmake-modules)

The following development headers are needed (recommended versions):
* Qt >= 5.4
* KF5 >= 5.11
* libX11
* libXss
* libqt-sql-sqlite
* libvlc
* libdvbv5

If you also want language translations you also need:
* gettext

If you also want the Kaffeine Handbook, you also need:
* KF5DocTools

Debian and Ubuntu
-----------------

The needed packages for Debian/Ubuntu should be installed with:

   apt-get install kdelibs5-dev libvlc-dev libxss-dev libkf5idletime-dev vlc \
		   libkf5coreaddons-dev libkf5i18n-dev libqt5x11extras5-dev \
		   libkf5solid-dev libkf5widgetsaddons-dev kio-dev \
		   qt5-default libdvbv5-dev libkf5notifications-dev \
		   cmake extra-cmake-modules make g++ gettext

And, to build the optional Kaffeine Handbook documentation:

   apt-get install kdoctools-dev

PS.: The above was tested with Debian SID and Ubuntu Xenial (16.04).
     Other versions may have different requirements.

Fedora
------

On Fedora, you need a repository that provides VLC.

For stable fedora releases, you could use the rpmfusion repository.
See http://rpmfusion.org/Configuration/ for instructions about how
to set it up.

For Fedora rawhide and beta releases, you could use, instead the
Unitedrpms repository: https://unitedrpms.github.io/. Please read
at https://github.com/UnitedRPMs/unitedrpms.github.io/blob/master/README.md
for instructions about how to set up.

Once the repository with VLC is set, install the needed packages
with:

   dnf install  kf5-kcoreaddons-devel extra-cmake-modules libXScrnSaver-devel \
		qt5-qtx11extras-devel kf5-kidletime-devel \
		kf5-knotifications-devel kf5-solid-devel kf5-kio-devel \
		kf5-kdbusaddons-devel kf5-ki18n-devel vlc-devel gettext-devel

And, to build the Kaffeine Handbook documentation:
   dnf install kf5-kdoctools-devel

PS.: The above was tested with Fedora 23 and Fedora 24.
     Other versions may have different requirements.

openSUSE
--------

If you run openSUSE Tumbleweed, you can find an up-to-date package with the
latest state of git in the KDE:Unstable:Extra repository.

    zypper ar obs://KDE:Unstable:Extra KDE_Unstable_Extra # add repository
    zypper in -r KDE_Unstable_Extra kaffeine

If you are using openSUSE Leap or openSUSE 13.2, you will need to compile from
sources instead.  You need to be using at least OpenSUSE version 13.2, in order to have
KF5 and Qt 5.5 at their repositories.

The first step is to install the needed dependencies:
   zypper install extra-cmake-modules vlc-devel make gcc gcc-g++ cmake \
   libqt5-qtbase-devel libqt5-qtx11extras-devel knotifications-devel \
   kdbusaddons-devel kidletime-devel solid-devel kio-devel ki18n-devel

If you're running OpenSUSE version 13.2, you'll need to compile the
libdvbv5 by hand, as it is not provided there. OpenSUSE Leap
(version 42.1) seem to have it already packaged as libdvbv5-devel.

Before compiling libdvbv5, some packages are needed:
	zypper install autoconf automake libjpeg-devel

Compiling libdvbv5 (as normal user):
	wget https://linuxtv.org/downloads/v4l-utils/v4l-utils-1.10.0.tar.bz2
	tar xvf v4l-utils-1.10.0.tar.bz2
	cd v4l-utils
	./bootstrap.sh && ./configure && make

Installing the library (as root):
	make install

And, to build the optional Kaffeine Handbook documentation:
	zypper install kdoctools-devel

PS.: The above was tested with openSUSE 13.2.
     Other versions may have different requirements.

Installing translations
-----------------------

This step is optional, and should be done only if you want to
use Kaffeine on non-English setups.

The Kaffeine tarballs should already have the translations on it,
but, if you're installing from the git tree, you'll need to run a
script to get them:
	(cd .. && kaffeine/tools/update_l10n.sh)

How to build Kaffeine
=====================

Create an empty build directory and do the following steps:
# cmake <path/to/kaffeine/source/directory> <options>
# make
# make install

Useful options include:
* -DCMAKE_BUILD_TYPE=<type> (Debug or Release)
* -DCMAKE_INSTALL_PREFIX=<path> (installation prefix for Kaffeine, e.g. /usr)
* -DBUILD_TOOLS=1 (also compile some tools needed by developers)

For further information look for generic KF5 / cmake instructions.

--------
Homepage
--------

http://kaffeine.kde.org

-------
Authors
-------

KF5 port maintainer:
  Mauro Carvalho Chehab <mchehab@osg.samsung.com>

Maintainer:
  Lasse Lindqvist <lasse.k.lindqvist@gmail.com>

Former maintainers:
  Christoph Pfister
  Christophe Thommeret
  Jürgen Kofler

Thanks to various contributors, translators, testers ...
