Difference between revisions of "Getting Started"

Jump to: navigation, search
m (Choose Version and Build Method: link to cmake page)
(Removed some duplicate I had left, heirarchical now.)
Line 1: Line 1:
 
{{Template:I18n/Language Navigation Bar|Getting_Started}}  
 
{{Template:I18n/Language Navigation Bar|Getting_Started}}  
  
 +
==Choose Version Method and Location==
 +
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]].
  
{{Box|Overview|
+
=== Version ===
* Choose version
+
For production use, we recommend using a stable version of KDE.  You may be able to do just fine with your distribution packages.
* Choose method of build
 
* Troubleshoot
 
* Use and Test / switch between versions for use
 
* contribute your development back to the system
 
|100%}}
 
  
==Getting the Source==
+
If you need to build it yourself You will probably want the latest stable version for which you have the ,[[Getting_Started/Build/KDE4/Prerequisites|prerequisites]] or  [[build requirements]]for your distribtion.
[[Image:Action_down.svg|right|32px]]
+
 
* [[Getting_Started/Sources/Anonymous SVN|Anonymous SVN Quickstart Guide]]
+
For developers, The TRUNK is the main branch where new features (and prerequisites) are added, however it can be difficult to keep up with.
* [[Getting_Started/Sources/Using Subversion with KDE|Using Subversion with KDE]] ''A more in depth look at accessing KDE source code with subversion, including the repository layout and working with revisions and patches.''
+
 
* [[Getting_Started/Sources/Amarok Git Tutorial|Amarok Git Tutorial]] ''Amarok has moved to Git (with the rest of KDE to follow), so it requires different steps to check out and develop.''
+
=== Location ===
* [[Getting_Started/Sources/Snapshots|Daily Snapshots]]
+
It is possible to install KDE in a variety of ways. Actual instructions for installation are determined by the method, however much is common between methods and reading all may be helpful.
* [http://websvn.kde.org/ Browse code online], or [http://lxr.kde.org/search search the code]
+
====system-wide====
 +
on development builds, do it to test KDM and other system level KDE functionality.  Obviously desired for production use.  If you are just testing KDM, you may want to use a virtual machine so you do not damage a production system.
 +
==== your home directory ====
 +
  Useful on development machines, or if you have no other access to the machine, however it can be confusing to set environment variables, however there are other advantages. and some scripts to help you use it.
 +
 
 +
==== development user home ====
 +
This is a common way to do it so that it does not interefere with the rest of your system. A common user name is kde-devel
  
 +
=== Method ===
  
==Choose Version and Build Method==
+
Reading up on [[Development/CMake|CMake]] may also be of interest.
[[Image:Action_tool.svg|right|32px]]
 
There are different KDE branches with different [[build requirements]].
 
For production use, we recommend using a stable version of KDE.  You will probably want the latest stable version for which you have the prerequisites.
 
  
The TRUNK is the main branch where new features (and prerequisites) are added.  
+
==== distribution specific ====
 +
If you use Kubuntu, consider Project Neon, where you may be able to download recent-enough Trunk Kubuntu packages and build enviornment.
  
The steps to build most branches are very similar. You can configure [[Getting_Started/Build/kdesrc-build|kdesrc-build]] to build most versions. Need link to build kde3 versions
+
==== kdesrc-build ====
 +
This script will do most of the downloading and compiling for you. There are  
 +
good instructions at http://kdesrc-build.kde.org
  
[[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]] information is similar between branches as well.
+
You can configure [[Getting_Started/Build/kdesrc-build|kdesrc-build]] to build most versions.  
  
Also consider Project Neon, where you may be able to download recent-enough Trunk Kubuntu packages and build enviornment.
+
* You will likely want to choose a recent branch
 +
* If you choose a branch, you will have to tweak the kdeSupport module description in the .kdesrc-buildrc
  
Reading up on [[Development/CMake|CMake]] may also be of interest.
 
  
=== Manual Steps ===
+
==== Manual Steps ====
 
* [[Getting_Started/Build/KDE4|KDE 4 (Development version, TRUNK)]]
 
* [[Getting_Started/Build/KDE4|KDE 4 (Development version, TRUNK)]]
 
* [[Getting_Started/Build/KDE4.x|KDE 4.x (Stable version or 4.x SVN BRANCH)]]
 
* [[Getting_Started/Build/KDE4.x|KDE 4.x (Stable version or 4.x SVN BRANCH)]]
 
* [[Getting_Started/Build/KDE4.4 Upgrade|Upgrade KDE-4.4.x release version or KDE-4.4 SVN BRANCH)]]
 
* [[Getting_Started/Build/KDE4.4 Upgrade|Upgrade KDE-4.4.x release version or KDE-4.4 SVN BRANCH)]]
 
* [[Getting_Started/Build|Other versions and FAQ]] ''Including information for building on non-linux systems''
 
* [[Getting_Started/Build|Other versions and FAQ]] ''Including information for building on non-linux systems''
 +
 +
 +
 +
 +
==Getting the Source==
 +
[[Image:Action_down.svg|right|32px]]
 +
* [[Getting_Started/Sources/Anonymous SVN|Anonymous SVN Quickstart Guide]]
 +
* [[Getting_Started/Sources/Using Subversion with KDE|Using Subversion with KDE]] ''A more in depth look at accessing KDE source code with subversion, including the repository layout and working with revisions and patches.''
 +
* [[Getting_Started/Sources/Amarok Git Tutorial|Amarok Git Tutorial]] ''Amarok has moved to Git (with the rest of KDE to follow), so it requires different steps to check out and develop.''
 +
* [[Getting_Started/Sources/Snapshots|Daily Snapshots]]
 +
* [http://websvn.kde.org/ Browse code online], or [http://lxr.kde.org/search search the code]
  
 
== Troubleshooting the build ==
 
== Troubleshooting the build ==
 
* [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]
 
* [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]
  
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, try:
+
[[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]] information is similar between branches as well.
[[Build/KDE4/Errors]] and IRC channel.
+
 
 +
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.   
  
==Setting up the Environment==
+
Please review your logs and do searches for fixes. If you cannot find a solution, [[Build/KDE4/Errors]] and IRC channel, and mailing lists.
 +
 
 +
==Using your KDE==
 +
After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:
 +
===Setting up Enviornment===
 
[[Image:Action_pen.svg|right|32px]]
 
[[Image:Action_pen.svg|right|32px]]
After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:
 
 
* [[Getting_Started/Increased Productivity in KDE4 with Scripts|Increased Productivity in KDE4 with Scripts]]
 
* [[Getting_Started/Increased Productivity in KDE4 with Scripts|Increased Productivity in KDE4 with Scripts]]
 
* [[Getting_Started/Set up KDE 4 for development|Set up KDE 4 for development]]
 
* [[Getting_Started/Set up KDE 4 for development|Set up KDE 4 for development]]
 
  
 
==Contribution==
 
==Contribution==

Revision as of 00:12, 13 July 2010


Getting_Started


Choose Version Method and Location

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.

Version

For production use, we recommend using a stable version of KDE. You may be able to do just fine with your distribution packages.

If you need to build it yourself You will probably want the latest stable version for which you have the ,prerequisites or build requirementsfor your distribtion.

For developers, The TRUNK is the main branch where new features (and prerequisites) are added, however it can be difficult to keep up with.

Location

It is possible to install KDE in a variety of ways. Actual instructions for installation are determined by the method, however much is common between methods and reading all may be helpful.

system-wide

on development builds, do it to test KDM and other system level KDE functionality. Obviously desired for production use. If you are just testing KDM, you may want to use a virtual machine so you do not damage a production system.

your home directory

 Useful on development machines, or if you have no other access to the machine, however it can be confusing to set environment variables, however there are other advantages. and some scripts to help you use it.

development user home

This is a common way to do it so that it does not interefere with the rest of your system. A common user name is kde-devel

Method

Reading up on CMake may also be of interest.

distribution specific

If you use Kubuntu, consider Project Neon, where you may be able to download recent-enough Trunk Kubuntu packages and build enviornment.

kdesrc-build

This script will do most of the downloading and compiling for you. There are good instructions at http://kdesrc-build.kde.org

You can configure kdesrc-build to build most versions.

  • You will likely want to choose a recent branch
  • If you choose a branch, you will have to tweak the kdeSupport module description in the .kdesrc-buildrc


Manual Steps



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.

Using your KDE

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

Setting up Enviornment

Action pen.svg

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

Content is available under Creative Commons License SA 4.0 unless otherwise noted.