Tellico/Compiling: Difference between revisions

    From KDE UserBase Wiki
    (Add notes about compiling with webcam support)
    (compilation instructions have moved)
    Line 1: Line 1:
    {{Template:I18n/Language Navigation Bar|Tellico/Compiling}}
    The instructions for compiling [[Tellico]] have [http://techbase.kde.org/Projects/Tellico/Compiling moved to TechBase].
     
    = Download Tellico =
     
    To compile [[Tellico]] from the source code, you must [http://tellico-project.org/download download the source package] or get the code from the KDE extragear/office SVN module.
     
    == Source Package ==
    If you download the source package, extract all of the files, which should create a directory named ''tellico-2.0/''.
    <code>
    % tar xjvf tellico-2.0.tar.bz2
    % cd tellico-2.0
    </code>
     
    {{Note|These instructions use Tellico 2.0 as an example. For other versions, replace 2.0 in the commands below.}}
     
    == Current Development Source ==
    Like all KDE applications, the source code is stored in KDE's Subversion system, in the ''extragear/office'' folder. Please refer to [http://techbase.kde.org/Getting_Started/Sources/Using_Subversion_with_KDE the Subversion Tutorial for KDE].
    <code>
    % svn co svn://anonsvn.kde.org/home/kde/trunk/extragear/office/tellico
    % cd tellico
    </code>
     
    After that, there are three steps to build and install Tellico.
     
    = Configure =
     
    The compilation environment must be configured to your system first. The tool used to create the configuration is ''[http://www.cmake.org CMake]''. CMake will check that you have all the required development libraries and set up the files for compiling.
     
    In the ''tellico-2.0/'' directory, create a directory for building, named ''build/'', just to keep things clear.
    <code>
    % mkdir build
    % cd build
    % cmake .. -DCMAKE_INSTALL_PREFIX=`kde4-config --prefix`
    </code>
     
    {{Note|Note the backquotes in the cmake command, they are important.}}
     
    The tells CMake to use the top-level ''tellico-2.0/'' directory as the source directory, and to set the application to install in the same place as other KDE applications. Later, when you install Tellico, you will likely need root access, either through the root password or ''sudo''. To install to a different
    location, use change the ''-DCMAKE_INSTALL_PREFIX'' option. Remember, the ''KDEDIRS'' variable must be updated if you install in a nonstandard location.
     
    If you do not have the necessary libraries for building tellico, CMake will fail and show you an error, listing which libraries you lack. Some libraries are required for building. Some are optional for additional functionality. The library packages may have different names, depending on your distribution.
     
    ==Options==
    In order to include support for using a webcam to scan barcodes, you must have the libv4l library installed and include ''-DENABLE_WEBCAM=true'' when you run cmake.
     
    To include support for debugging Tellico, you should pass the ''-DCMAKE_BUILD_TYPE=debug'' option to cmake. ''-DCMAKE_BUILD_TYPE=release'' is for stripped, non-debugging compilation.
     
    Tellico has many unit tests for checking some parts of the code for problems. The tests can be compiled by using ''-DKDE4_BUILD_TESTS=TRUE'' and then running
    <code>% make test</code>
    = Compile =
     
    ''Make'' is used to actually compile Tellico.
    <code>% make</code>
     
    There will likely be some warnings during compilation, but at the end, if you see something like
     
    [100%] Built target tellico
     
    then the compilation completed successfully.
    = Install =
    To install Tellico alongside other KDE applications, you will likely need to use the ''sudo'' command.
    <code>% sudo make install</code>
     
    Enter your password, and Tellico should be installed and should show up in the KDE menu, likely in the Office menu. Or, run it from the command-line.
    <code>% tellico</code>
    = Enjoy =
     
    You can send questions to the [http://tellico-project.org/mailing-list tellico-users mailing list].
     
    If you need to uninstall Tellico
    <code>% sudo make uninstall</code>

    Revision as of 17:01, 20 November 2009

    The instructions for compiling Tellico have moved to TechBase.