Difference between revisions of "Getting Started"

Jump to: navigation, search
m (Location)
(Determine Your Needs: still awkward, but less unneeded verbage)
Line 3: Line 3:
 
== Determine Your Needs==
 
== Determine Your Needs==
 
KDE versions are split into branches off of the Trunk. The steps to build most branches are very similar. However, Each branch has different [[Getting_Started/Build/KDE4/Prerequisites|prerequisites]].  
 
KDE versions are split into branches off of the Trunk. The steps to build most branches are very similar. However, Each branch has different [[Getting_Started/Build/KDE4/Prerequisites|prerequisites]].  
 +
 +
You will need to know what version you want, how often you will use the development environment (more work upfront may be justified if you intend to use it more),
  
 
=== [[Choose Version]] ===
 
=== [[Choose Version]] ===
For production use, we recommend using a stable "branch" version of KDE.  If you just want to use KDE, take a look at http://userbase.kde.org/.  If you are developing applications, your distribution's dev packages and the kde-sdk may work. If your distribution does not have KDE you'll need to build it yourself.
+
; Synchronized with distribution
 +
:  [[Distributions with KDE]] may provide KDE Dev and SDK for 3rd party development
 +
; Latest Features for production
 +
: [[branch]] (stable / beta)
 +
; [[Core Development]]
 +
: [[trunk]]
  
If you want to hack at KDE's core modules, you'll need to build it, and TRUNK is the main branch where new features (and prerequisites) are added, however it can be difficult to keep up with.
+
[[Getting_Started/Build|other Supported Platforms]] ''Including information for building on non-linux systems Incl KDE3'' [[Older Versions]]
 
+
[[Getting_Started/Build|Other versions and FAQ]] ''Including information for building on non-linux systems Incl KDE3''
+
  
 
To See which versions/branches of KDE are available go to:
 
To See which versions/branches of KDE are available go to:
Line 15: Line 20:
  
 
=== Location ===
 
=== Location ===
There may be advantages to putting your KDE in different locations.( Note that if using system Qt for a user based KDE install, the [[QCA plugin]] may have to be installed as root))
+
Choose where you want to put the KDE installation, and keep source and build directories.
 +
( [[QCA plugin]] may have to be installed as root if using system Qt))
 +
====Source and Build Directories====
 +
: suggested:  ~/kde/src  and ~/kde/build  (where ~ is the user which runs KDE)
 +
: possibly /usr/src/  if [[building as root]]
  
 +
====Installation Directory====
 
;[[Casual Curiosity]]
 
;[[Casual Curiosity]]
 
: [[development user home]] if you do not want to mess up your production KDE
 
: [[development user home]] if you do not want to mess up your production KDE
 
: [[your home directory]] if you are willing to use environment variables to keep versions seporate( using [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|scripts]]) or have no other access to the machine
 
: [[your home directory]] if you are willing to use environment variables to keep versions seporate( using [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|scripts]]) or have no other access to the machine
 
: [[As root]] Not advised unless you have a dedicated machine
 
: [[As root]] Not advised unless you have a dedicated machine
 
  
 
; [[Application Developer]]
 
; [[Application Developer]]
Line 33: Line 42:
 
=== Method ===
 
=== Method ===
  
Regardless of method chosen, reading up on the manual steps below will be very helpful.
+
Read up on steps below. [[Development/CMake|CMake]] may also be of interest.
[[Development/CMake|CMake]] may also be of interest.
+
  
; Fully Manual
+
; Fully Manual -- to learn how things work
 
; Distribution Specific  
 
; Distribution Specific  
 
; Augmented (Recommended)
 
; Augmented (Recommended)
: Manual, but with a few scripts to keep everything easy
+
: most common method, set environment variables and use scripts.
 
; KDEsrc-build  
 
; KDEsrc-build  
 
: Useful for automated builds, may be tough to set up
 
: Useful for automated builds, may be tough to set up

Revision as of 04:20, 6 August 2010


Contents

Getting_Started


Determine Your Needs

KDE versions are split into branches off of the Trunk. The steps to build most branches are very similar. However, Each branch has different prerequisites.

You will need to know what version you want, how often you will use the development environment (more work upfront may be justified if you intend to use it more),

Choose Version

Synchronized with distribution
Distributions with KDE may provide KDE Dev and SDK for 3rd party development
Latest Features for production
branch (stable / beta)
Core Development
trunk

other Supported Platforms Including information for building on non-linux systems Incl KDE3 Older Versions

To See which versions/branches of KDE are available go to:

http://websvn.kde.org/branches/KDE/

Location

Choose where you want to put the KDE installation, and keep source and build directories. ( QCA plugin may have to be installed as root if using system Qt))

Source and Build Directories

suggested: ~/kde/src and ~/kde/build (where ~ is the user which runs KDE)
possibly /usr/src/ if building as root

Installation Directory

Casual Curiosity
development user home if you do not want to mess up your production KDE
your home directory if you are willing to use environment variables to keep versions seporate( using scripts) or have no other access to the machine
As root Not advised unless you have a dedicated machine
Application Developer
development user home same as for curious user
as root will be more useful to simulate environment of customers
your home directory may simplify your development
Distribution Manager
To test KDM, you may want to install as root and or use a virtual machine so you do not damage a production system.

Method

Read up on steps below. CMake may also be of interest.

Fully Manual -- to learn how things work
Distribution Specific
Augmented (Recommended)
most common method, set environment variables and use scripts.
KDEsrc-build
Useful for automated builds, may be tough to set up

Gather Prerequisites

Your build will fail if you are missing one of them, and the list changes. There are some options, however the make system can often find optional packages even if you do not intend to use them, so you may need to pass disable options.

Build it

Most used method, augmented with bash functions.

Getting_Started/Increased_Productivity_in_KDE4_with_Scripts

Manual Steps
distribution specific

There may be pre-made builds for your distribution, For example, in Kubuntu, Project Neon, aims to provide a recent trunk build environment, and PPA's provide latest branch versions.

kdesrc-build

This script will do most of the downloading and compiling for you. It can be configured to build most versions, by default it builds Trunk. There full-process instructions at http://kdesrc-build.kde.org and more here kdesrc-build, and here is a list of working configuration files.

  • This will compile qt for you, or you can configure it to use system QT
  • When you choose a branch
    • edit your .kdesrc-buildrc
      • set your branch
      • you will have to tweak the kdeSupport module description, and maybe the qt-copy. For the kdesupport module: module-base-path tags/kdesupport-for-4.5

Getting the Source

Action down.svg

Troubleshooting the build

Troubleshooting information is similar between branches as well.

Compile and Linking errors are frequent sources of discouragement. make careful note of the first occurrence of an error in your build process. It could be as simple as a bad environment variable, an unexpected version of a library or missing prerequisite.

Please review your logs and do searches for fixes. If you cannot find a solution, Build/KDE4/Errors and IRC channel, and mailing lists. Build/Stories

Using your KDE

After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:

Environment Variables

Your system won't know to use your new KDE until you tell it how to find the KDE applications and libraries.

Action pen.svg

Set up Development Tools

You may need to set up or use, you will likely want to use a stable package from your distribution.

it is unclear if the kde-devel user or your normal user will be running the development tools. Please Help

For most development topics, and documentation, see Development

Opening and creating KDE project files


This is a stub, please help.

Contribution

You may not need the latest bleeding-edge KDE to develop with, Much code will be similiar between versions and your patch might work, however Trunk is where major changes are introduced, and branches are mostly maintenance/bug fix.

Action tool.svg

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal