KDE TechBase - User contributions [en]

Projects

2013-03-17T16:15:38Z

Cojack: /* Programs */ add the kdevelop application icon from git

{{note|KDE TechBase Translators: The Projects part is rather a scratchpad for arbitrary projects. It contains texts like IRC logs and rough ideas. ''It probably does not make sense to translate this''. If, however, you wish some part to be translated please either email kde-www@kde.org or comment on #kde-www.}}

{{note|These pages are intended for providing technical documentation for external users of various KDE Projects. For internal project documentation, such as feature plans and meeting minutes please use http://community.kde.org/.}}

= Infrastructure =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/MovetoGit|KDE migration to git]]
:KDE is moving from svn to git, find progress, todo list, etc. here.
|-
|}

= Organisational =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[http://www.kde.org/community/getinvolved Get Involved with KDE]
:General information for getting involved with KDE projects. Includes a mentor directory for many projects.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/Release_Team|KDE Release Team]]
:The KDE Release Team.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/Documentation|KDE Documentation Project]]
:Creating and maintaining KDE documentation.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/kde.org|kde.org]]
:Information around the *.kde.org websites.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/Promo|KDE Promotion]]
:Promoting KDE and conference organization.
|-
|[[Image:Action_world.svg|noframe|left|40px]] ||
;[[/Partners|Partner Program]]
:KDE partner program targetting ISVs.
|-
| ||
;[[/Usability | KDE Usability project]]
: The KDE Usability Project is an initiative to apply usability principles and practices to the K Desktop Environment.
|-
| [[Image:Bugweeks ladybug.png|noframe|left|40px]]||
;[[Contribute/Bugsquad|KDE BugSquad]]
:The KDE BugSquad keeps track of incoming bugs in KDE software, and goes through old bugs.
|-
| ||
;[[/Summer_of_Code|Summer of Code Projects]]
:Information on Summer of Code projects and prospects related to KDE
|-
| ||
;[[/English Breakfast Network|KDE Code Quality (EBN)]]
: The English Breakfast Network and associated tools dedicated to KDE Quality, including: KDE API Documentation Validation, User Documentation Validation, Source Code Checking, ...
|-
| ||
;[[/KDE Research|KDE Research]]
: Project and community for everyone who is interested in contributing to (funded) research projects with(in) the KDE community.
|-
|}

= Frameworks =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:logo_oxygen.png|noframe|left|40px]] ||
;[[/Oxygen|The Oxygen Project]]
:Artwork for KDE4.
|-
|[[Image:Klogo-official-crystal.svg|noframe|left|40px]] ||
;[[/kdelibs|KDE Core Libraries]]
:For the core developers working on the kdelibs module.
|-
|[[Image:Decibel.png|noframe|left|40px]] ||
;[[/Decibel|Decibel]]
:Decibel - Realtime communications framework
|-
| ||
;[[/KGLEngine2D | KGLEngine2D]]
: KGLEngine2D is a framework designed to greatly simplify the development of reach multimedia applications on KDE enabled platforms.
|-
| ||
;[[/KioFuse|KioFuse]]
: Insert KIO resources (remote, archived or compressed files) into the root filesystem hierarchy.
|-
|[[Image:Nepomuk_logo.png|noframe|left|40px]] ||
;[[/Nepomuk|Nepomuk]]
:Nepomuk Semantic Desktop project - Annotation/Indexing/Search/Linking
|-
|[[Image:Action_filequickprint.svg|noframe|left|40px]] ||
;[[/KDEPrint|KDEPrint]]
:Printing related information for KDE.
|-
|[[Image:knetworkmanager.png|noframe|left|40px]] ||
;[[/Network_Management|Network Management]]
: Development on Solid Networking, KNetworkManager applet and configuration tool.
|-
| ||
;[[/D-Bus-WS|D-Bus Web Service Proxy]]
: Fusion of D-Bus services and web services.
|-
| ||
;[[/Silk | Silk]]
: Project Silk - Deep integration of the web
|-
| ||
;[[/Solid | Solid]]
: Solid - The KDE Hardware Library
|-
| ||
;[[/Kbluetooth | Kbluetooth]]
: Kbluetooth - The KDE Bluetooth Library (deprecated)
|-
| ||
;[[/kdesu|kdesu]]
: Considerations and coordination to make kdesu work well with several backends.
|-
| ||
;[[/Telepathy|Telepathy]]
:Telepathy Realtime Communication Framework - Instant Messaging, VoIP and Collaboration.
|-
| ||
;[[/WebKit|WebKit (webkitkde)]]
: Project which aims to integrate WebKit (QtWebKit) into KDE.
|-
| ||
;[[/Widgets and Classes|Widgets & Classes]]
:Widgets and classes that are not in kdelibs but which you may find useful.
|-
| ||
;[[/KSecretsService|KSecretsService - managing KDE application's secrets]]
:Secrets management infrastructure for KDE applications and a collection of related tools, superseding KWallet.
|-
| ||
;[[/Related|Related Projects]]
: Projects which are related to KDE in any way, as dependencies or build tools.
|-
|}

= Programs =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
| [[Image:Aki128.png|noframe|left|40px]]||
;[[/Aki | Aki]]
: Aki - Extensive IRC Client
|-
|||
;[[/Digikam|Digikam]]
:Digikam - Photo Management Software.
|-
| [[Image:Hisc-apps-kget.svg|noframe|left|40px]]||
;[[/KGet|KGet]]
: KGet, a KDE Downloader
|-
| ||
;[[/Gwenview|Gwenview]]
:Gwenview, the image viewer.
|-
|[[Image:K3b.png|noframe|left|40px]] ||
;[[/K3b|K3b]]
:K3B, optical disc writer
|-
|[[Image:Hi48-app-kdevelop.png|noframe|left|40px]] ||
;[[/KDevelop4|KDevelop4]]
:KDevelop4, the KDE IDE.
|-
|[[Image:Knights.png|noframe|left|40px]] ||
;[[/Knights|Knights]]
:A chess program for the KDE Platform.
|-
|[[Image:Kopete.svg|noframe|left|40px]] ||
;[[/Kopete|Kopete]]
:Kopete, the KDE Instant Messaging program.
|-
|[[Image:Marble.png|noframe|left|40px]] ||
;[[/Marble|Marble]]
:Marble Desktop Globe - Can You Feel The Earth Spinning?
|-
| ||
;[[/Okular|Okular]]
:Okular, the unified document viewer.
|-
| ||
;[[/rekonq | rekonq]]
: rekonq - A lightweight Web Browser for KDE based on WebKit
|-
|[[Image:Ktimetracker.png|noframe|left|40px]] ||
;[[KTimeTracker]]
:Time management within the KDE PIM.
|-
| ||
;[[/SystemSettings|System Settings]]
: Development on the System Settings configuration tool.
|-
|[[Image:superkaramba.png|noframe|left|40px]] ||
;[[/SuperKaramba|SuperKaramba]]
:SuperKaramba is a tool that allows you to easily create interactive eye-candy on your KDE desktop.
|-
| ||
;[[/KWin|KWin]]
: The KDE Window Manager.
|-
|}

= Suites =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:Action_book2.svg|noframe|left|40px]] ||
;[[/Edu|KDE Education Project]]
:Developing educational software for KDE.
|-
| ||
;[[/extragearReleases|Extragear Releases]]
: A current list of what extragear apps are to be released in sync with the core KDE release schedule.
|-
| ||
;[[/KdeFinance | KDE Finance]]
: KDE Finance is a group of KDE-related financial applications
|-
|[[Image:Kdegameslogo_40.png|noframe|left|40px]] ||
;[[/Games|KDE Games Project]]
:Developing desktop's games for KDE.
|-
|[[Image:Action_pencil.svg|noframe|left|40px]] ||
;[[/KOffice|KOffice]] and [http://wiki.koffice.org KOffice.org]
:Developing an Office suite based on KDE.
|-
|[[Image:Action_pencil.svg|noframe|left|40px]] ||
;[[/Calligra/]] and [http://calligra.org Calligra.org]
:Developing an Office suite for KDE.
|-
|[[Image:Action_mail_generic.svg|noframe|left|40px]] ||
;[[/PIM|KDE PIM Project]]
:KDE Personal Information Management.
|-
|[[Image:Plasma_logo.jpg|noframe|left|40px]] ||
;[[/Plasma|Plasma]]
:Quick and easy creation of widgets. Interactive application launchers, window and task managers, weather checkers; they are all made with plasma.
|-
| ||
;[[/Kdetoys | Kdetoys]]
: The Kdetoys project
|-
|[[Image:kdeutils-logo.svg|noframe|left|40px]] ||
;[[/Utils|KDE Utilities Team]]
:For the developers working on the kdeutils module.
|-
| ||
;[[/Necessitas | Necessitas]]
: Necessitas project
|-
|}

= Platforms =

{| style="margin: 1em 2.5% 0 2.5%; padding: 0 5px;" cellpadding="5"
|-
|[[Image:KDE-Mac.png|noframe|left|40px]] ||
;[[/KDE on Mac OS X|KDE on Mac OS X]]
: KDE libraries and applications on Mac OS X.
|-
|[[Image:Konqi-win.png|38px]] ||
;[[/KDE on Windows|KDE on Windows]]
: KDE libraries and applications on MS Windows.
|-
| ||
;[[/KDE on Solaris|KDE on Solaris]]
: KDE libraries and applications on Sun Microsystems Solaris and OpenSolaris.
|-
| ||
;[[/KDE on FreeBSD|KDE on FreeBSD]]
: KDE libraries and applications on FreeBSD and other BSDs.
|-
| ||
;[[Projects/Mobile|Mobile]]
: Project for porting KDE to the Mobile.
|-
|}

__NOTOC__

File:Hi48-app-kdevelop.png

2013-03-17T16:14:13Z

Cojack: KDevelop App Icon

KDevelop App Icon

Projects/KDevelop4/HowToCompile

2013-03-17T15:42:22Z

Cojack: add information about libgrantlee-dev package in ubuntu, is available since lucid-backports

The way to download, compile, install and run KDevelop depends on how you want to download it and where do you want to install it to.
So follow the step by step instructions below.

'''WARNING:''' You have to remove all KDevelop packages provided by your distribution. If you don't do that, binary compatibility issues will eventually lead to crashes and undefined behavior. To make sure, you can search for KDevelop libraries with this command:

<pre>find /usr/ -type f -name "*kdev*.so*"</pre>

If no results are returned, you should be on the safe side.

== 1. Get the requirements ==
Make sure to install the required KDE development packages, see [[KDevelop4/requirements]] for a list of requirements. In particular make sure to install KDE4 kdelibs development packages. At least following packages are required:

In Fedora 13: kdelibs-devel kdebase-workspace-devel

In Ubuntu 11.04: cmake gcc g++ kdelibs5-dev zlib1g-dev kdebase-workspace-dev libgrantlee-dev

In Debian: same as ubuntu, but you also need to compile at Grantlee in at least version 0.1.7, though I suggest to use the latest stable release. See http://downloads.grantlee.org/ and http://www.gitorious.org/grantlee/pages/Home

When configuring kdevplatform, these packages are needed to remedy the following errors:
kdelibs5-dev: ERROR: Could not find KDE4 kde4-config
zlib1g-dev: Could NOT find ZLIB

When configuring kdevelop, these packages are needed to remedy the following errors:

Could NOT find KDE4Workspace

== 2. Get the sources (assumes ''$HOME/src'' but you can replace it with something else) ==
* By downloading it to ''$HOME/src''
** download ''kdevplatform.tar.bz2'' and ''kdevelop.tar.bz2'' from http://download.kde.org/download.php?url=stable/kdevelop/4.1.2/src/
** unpack them:
cd $HOME/src
tar xvjf kdevplatform.tar.bz2
tar xvjf kdevelop.tar.bz2

* '''Or''', by getting the latest master branch sources directly out of the Git server
git clone git://anongit.kde.org/kdevplatform $HOME/src/kdevplatform
git clone git://anongit.kde.org/kdevelop $HOME/src/kdevelop

Please note that this branch will depend on MovingRange in Kate, meaning KDE 4.5 and above. This can be updated by doing sudo yum update kdelibs or equivalent.

* '''Or''', by getting the latest 4.5-branch sources directly out of the Git server. First you need to do clone git reposity as above, and then tell git to use branch 1.5 for kdevplatform and branch 4.5 for kdevelop:
cd $HOME/src/kdevplatform ; git checkout -b 1.5 origin/1.5
cd $HOME/src/kdevelop ; git checkout -b 4.5 origin/4.5

== 3. Configure and install ==

You can do a system install of KDevelop in the default path (/usr/local), which needs root privileges,
or you can install it locally for your user only.
The instructions for both are slightly different;
first we'll explain the local install.

In both cases you need set the KDEDIRS environment variable to point to the installation directory of both KDE4 and KDevPlatform.

This will tell KDE core components where to search for plugins and other data related to KDE apps and contains just a list of paths (aka prefixes) where KDE libraries and/or applications have been installed.

Assuming that you have the KDE4 libraries installed in ''/usr'' (these are often from packages and installed in ''/usr'' or ''/opt/kde'' and is distro specific, if unsure ask your distro where it is), you'll have to append it to the KDEDIRS below.

=== Local installation ===

The following commands give instructions to install in ''$HOME/kdevelop4'';
you can of course replace it with something else.
You don't need root permissions to install KDevelop this way.

First, compile and install KDevPlatform:

mkdir -p $HOME/src/kdevplatform/build
cd $HOME/src/kdevplatform/build
cmake -DCMAKE_INSTALL_PREFIX=$HOME/kdevelop4 ../
make
make install

Then compile KDevelop, telling it to use the just-installed KDevPlatform:

mkdir -p $HOME/src/kdevelop/build
cd $HOME/src/kdevelop/build
cmake -DCMAKE_PREFIX_PATH=$HOME/kdevelop4 -DCMAKE_INSTALL_PREFIX=$HOME/kdevelop4 ../
make
make install

Before running KDevelop, you need set the KDEDIRS environment variable. Assuming that you want to install KDevelop4 into ''$HOME/kdevelop4'' then you need to run the following:

export KDEDIRS=$HOME/kdevelop4:$KDEDIRS
kbuildsycoca4

Note that this will set the KDEDIRS variable only for that shell (so launching kdevelop from desktop launcher will fail). A good solution is to add to a small script to ''$HOME/.kde/env'' that sets the KDEDIRS variable to proper. For example you may call it ''$HOME/.kde/env/kdedirs.sh'' and it could contain:

#!/bin/bash
export KDEDIRS=/usr/local/:$KDEDIRS

And it needs to have execution permissions. If you want to use it directly, you'll have to logout of your current KDE session and log in again, otherwise this script won't be sourced of course...

=== System installation ===
First, compile and install KDevPlatform:
mkdir -p $HOME/src/kdevplatform/build
cd $HOME/src/kdevplatform/build
cmake ../
make
sudo make install

Then compile KDevelop:

mkdir -p $HOME/src/kdevelop/build
cd $HOME/src/kdevelop/build
cmake ../
make
sudo make install

Before running it, you need to set KDEDIRS properly as in local installation but with path as /usr/local/.

== 4. Get and install plugins (optional) ==

If you need extra functionality, you can get and install additional plugins for KDevelop4. Stable plugins can be found in Extragear: https://projects.kde.org/projects/extragear/kdevelop/plugins . Experimental, potentially unstable or even broken plugins can be found in Playground: https://projects.kde.org/projects/playground/devtools/plugins .

Many plugins you can find there (e.g. PHP, CSS, QMake, ...) require the KDevelop-PG-Qt parser generator. You can find that here: https://projects.kde.org/projects/extragear/kdevelop/utilities/kdevelop-pg-qt

Check the sources out and compile the plugin using the same steps as above, e.g. for PHP:

<pre>
mkdir -p $HOME/src/kdev-php/build
cd $HOME/src/kdev-php/build
cmake -DCMAKE_PREFIX_PATH=$HOME/kdevelop4 -DCMAKE_INSTALL_PREFIX=$HOME/kdevelop4 ../
make
make install
</pre>

Make sure to run <code>kbuildsycoca4</code> after installation (see above)!

== 5. Run KDevelop ==
Just execute:
$HOME/kdevelop4/bin/kdevelop

(If you want to ease it, you can add $HOME/kdevelop4/bin/ to your $PATH env variable).

== 6. Contact the development team, or report bugs or wishes ==
If you find any compile problems with KDevelop4 please report them on our [http://www.kdevelop.org/index.html?filename=mailinglist.html developer mailing-list].
If you find problems while using KDevelop4 use, the [http://bugs.kde.org/ bugzilla bug database] which is only for bugs ('''not''' for compilation issues).

If you find bugs that cause program to crash and you are going to make bug report out of it, please re-compile the program with debug symbols. This is done with options
<pre>-DCMAKE_BUILD_TYPE=debugfull</pre>
passed to cmake in configuration step. Also be sure to update kdevelop and kdevplatform to newest version, your bug might be already fixed.

== 7. Keeping it up-to-date with the latest fixes ==
If you got the sources from the git repository on step 2. then you can update by issuing the following commands:
* with '''root permissions''' do this
cd $HOME/src/kdevelop/build && sudo make uninstall
cd $HOME/src/kdevplatform/build && sudo make uninstall
cd $HOME/src/kdevplatform && git pull
cd $HOME/src/kdevplatform/build && make && sudo make install
cd $HOME/src/kdevelop && git pull
cd $HOME/src/kdevelop/build && make && sudo make install
kbuildsycoca4
* '''Or''' if installed in local directory
cd $HOME/src/kdevelop/build && make uninstall
cd $HOME/src/kdevplatform/build && make uninstall
cd $HOME/src/kdevplatform && git pull
cd $HOME/src/kdevplatform/build && make && make install
cd $HOME/src/kdevelop && git pull
cd $HOME/src/kdevelop/build && make && make install
kbuildsycoca4

You can also see here [https://projects.kde.org/projects/extragear/kdevelop/ the latest changes] in the KDevelop projects.

== 8. Troubleshooting ==
* When running cmake on KDevelop, you get "Could NOT find KDE4Workspace". You need to install the kdebase-workspace-dev package.