amarok/HACKING/building_amarok2_in_home.txt

0001 This document explains how to install Amarok 2 from git in your home directory - in an easy way :)
0002 ==================================================================================================
0003
0004 A detailed blog post on how to make a local build can be found here: http://blogs.fsfe.org/myriam/2009/09/26/compiling-amarok-from-git-locally-full-summary/
0005
0006 * If you already have Amarok installed from your distro, uninstall it to prevent setting conflicts and similar.
0007
0008 * Install git, the compiler and KDE 4 development packages:
0009
0010   In Kubuntu, Debian, and all their derivatives:
0011     sudo aptitude install git-core build-essential kdesdk kdelibs5-dev libkonq5-dev kdebase-workspace-dev
0012
0013   In Archlinux:
0014     sudo pacman -Sy git base-devel kdelibs kdebase-runtime
0015
0016   In Gentoo:
0017     sudo emerge -av dev-util/git kdelibs plasma-workspace
0018
0019   In OpenSuSE:
0020     sudo zypper install git
0021
0022   In Fedora:
0023     sudo yum install git kdelibs-devel
0024
0025
0026 *  Install ccache to speed up compilation
0027     ccache -M 2G
0028
0029 * Append the following to $HOME/.bashrc:
0030     export PATH=$HOME/kde/bin:$PATH
0031     export KDEDIR=$HOME/kde
0032     export KDEDIRS=$KDEDIR
0033
0034 * Reload your edited .bashrc:
0035     source $HOME/.bashrc
0036
0037     NOTE: if you are not using the bash shell, edit your proper shell config file (~/.zshrc or ~/.tcshrc or whatever it may be)
0038
0039 * Make KDE aware of Amarok's plugin location:
0040     echo 'export KDEDIR=$HOME/kde' >> $HOME/.kde/env/myenv.sh
0041     echo 'export KDEDIRS=$KDEDIR' >> $HOME/.kde/env/myenv.sh
0042
0043   Some distributions call the above folder $HOME/.kde4/... (OpenSuSE in particular).
0044
0045 * Create folders:
0046     mkdir $HOME/kde
0047     mkdir $HOME/kde/src
0048     mkdir -p $HOME/kde/build/amarok
0049
0050 * Make sure you have all necessary dependencies
0051     See the README file for the complete list of necessary dependencies. Make sure you have the development files of these packages.
0052     For distribution specific requirements refer to http://community.kde.org/Amarok/Development/Development_HowTo
0053
0054 * Check out Amarok:
0055     cd $HOME/kde/src
0056     git clone git://anongit.kde.org/amarok
0057
0058 * Building:
0059     cd $HOME/kde/build/amarok
0060     cmake -DCMAKE_INSTALL_PREFIX=$HOME/kde -DCMAKE_BUILD_TYPE=debugfull $HOME/kde/src/amarok
0061     make install
0062
0063 * Enabling unit tests:
0064
0065   If you are a regular Amarok contributor, please build with tests enabled.
0066
0067   Install gmock from https://github.com/google/googlemock
0068
0069   Once compiled, just run the tests with 'make test'
0070
0071   For more information about the test infrastructure, read the Qtestlib Manual: http://doc.qt.io/qt-5/qtest-overview.html
0072
0073 * Updating KDE Config:
0074     kbuildsycoca4 --noincremental
0075
0076
0077 Now you are ready to run Amarok 2, by typing "amarok" in the shell :)
0078
0079 Please also refer to the following wiki page
0080     http://techbase.kde.org/Getting_Started/Sources/KDE_git-tutorial
0081
0082 NOTE:
0083 If you have installed MySQL Embedded in non-default location (i.e. $HOME/usr),
0084 Amarok may fail to start with error regarding libmysqlclient library. In this
0085 case, add the following string to your ~/.bashrc:
0086     export LD_LIBRARY_PATH=$HOME/usr/lib/mysql:$LD_LIBRARY_PATH
0087
0088 where $HOME/usr is the path you've used in --prefix option.
0089
0090
0091 Have fun :)