K3b/Getting Started: Difference between revisions

From KDE Community Wiki
< K3b
m (Text replace - "<code>" to "<syntaxhighlight lang="text">")
m (Text replace - "</code>" to "</syntaxhighlight>")
Line 8: Line 8:
export PATH=${K3B_INSTALL_PREFIX}/bin:${PATH}
export PATH=${K3B_INSTALL_PREFIX}/bin:${PATH}
export XDG_DATA_DIRS=${K3B_INSTALL_PREFIX}/share:${XDG_DATA_DIRS}
export XDG_DATA_DIRS=${K3B_INSTALL_PREFIX}/share:${XDG_DATA_DIRS}
</code>
</syntaxhighlight>
Relogin to let changes take effect.
Relogin to let changes take effect.


Line 17: Line 17:
<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
git clone git://anongit.kde.org/k3b
git clone git://anongit.kde.org/k3b
</code>
</syntaxhighlight>
If you have development access you should go the other way:
If you have development access you should go the other way:
<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
git clone ssh://[email protected]:k3b
git clone ssh://[email protected]:k3b
</code>
</syntaxhighlight>
This will give you right to push back your changes to the origin repository.
This will give you right to push back your changes to the origin repository.


Line 32: Line 32:
mkdir build
mkdir build
cd build
cd build
</code>
</syntaxhighlight>
It is guaranteed all files created during build will be placed in this directory. That means that if you want to clean up source tree after build the only thing you need to do is to remove <tt>build</tt> directory.
It is guaranteed all files created during build will be placed in this directory. That means that if you want to clean up source tree after build the only thing you need to do is to remove <tt>build</tt> directory.


Line 42: Line 42:
       -DK3B_DEBUG=ON \
       -DK3B_DEBUG=ON \
       -DCMAKE_BUILD_TYPE=Debug
       -DCMAKE_BUILD_TYPE=Debug
</code>
</syntaxhighlight>
CMake will search for all required and optional libraries.
CMake will search for all required and optional libraries.


Line 48: Line 48:
<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
make && make install
make && make install
</code>
</syntaxhighlight>


After that compiled K3b will be placed in <tt>/home/joe/k3b/install</tt> directory. Now you can run K3b by simply typing in the console:
After that compiled K3b will be placed in <tt>/home/joe/k3b/install</tt> directory. Now you can run K3b by simply typing in the console:
<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
k3b
k3b
</code>
</syntaxhighlight>


==See Also==
==See Also==
* [http://community.kde.org/K3b K3b community wiki] &ndash; for roadmap and other organizational information
* [http://community.kde.org/K3b K3b community wiki] &ndash; for roadmap and other organizational information

Revision as of 20:57, 29 June 2011

Getting Started in K3b Development

Setting Up Environment

Create target install directory. For the sake of example we will assume your home directory is /home/joe and you will install your compiled K3b to /home/joe/k3b/install. Add following lines to your ~/.bashrc file: 

export K3B_INSTALL_PREFIX=/home/joe/k3b/install
export KDEDIRS=${K3B_INSTALL_PREFIX}:${KDEDIRS}
export PATH=${K3B_INSTALL_PREFIX}/bin:${PATH}
export XDG_DATA_DIRS=${K3B_INSTALL_PREFIX}/share:${XDG_DATA_DIRS}

Relogin to let changes take effect.

Getting Source Code

K3b sources code is hosted in KDE git repository. It is a part of KDE Extragear module

If you don't have a KDE development access you can get the source code using anonymous access repository: 

git clone git://anongit.kde.org/k3b

If you have development access you should go the other way: 

git clone ssh://[email protected]:k3b

This will give you right to push back your changes to the origin repository.

Compilation

K3b, as most KDE applications, uses CMake for configuration and compilation of source code.

First the build directory should be created. 

cd k3b
mkdir build
cd build

It is guaranteed all files created during build will be placed in this directory. That means that if you want to clean up source tree after build the only thing you need to do is to remove build directory.

Now we need to configure the source tree. This have to be done only once, later this step will be invoked automatically when necessary. If you are familiar with Autotools this step corresponds to ./configure command. 

cmake .. \
      -DCMAKE_INSTALL_PREFIX=/home/joe/k3b/install \
      -DKDE4_AUTH_POLICY_FILES_INSTALL_DIR=/home/joe/k3b/install/share/polkit-1/actions \
      -DK3B_DEBUG=ON \
      -DCMAKE_BUILD_TYPE=Debug

CMake will search for all required and optional libraries.

Finally to compile the source code and install it you should call: 

make && make install

After that compiled K3b will be placed in /home/joe/k3b/install directory. Now you can run K3b by simply typing in the console: 

k3b

See Also

Retrieved from "https://community.kde.org/index.php?title=K3b/Getting_Started&oldid=56439"