Difference between revisions of "Getting Started"

Jump to: navigation, search
(Getting Help)
m (Clean up introduction.)
(49 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Getting_Started}}
+
<languages />
 +
<translate>
  
{{warning|This page is yet to be reviewed for changes required by the migration to Git.  Information and commands on this page may no longer be valid and should be used with care. Please see the [[Development/Git|KDE Git hub page]] for more details. }}
+
<!--T:1-->
 +
{{Warning|These pages are currently being completely re-written to reflect the new KDE infrastructure and may not be in a consistent state.  Information and commands on some page may no longer be valid and should be used with care.}}
  
== Introduction ==
+
== Introduction == <!--T:3-->
There are several possible ways to build and install KDE software and the method you choose depends on what you want to do with the software once it is built.
+
  
You may want to:
+
<!--T:4-->
* Develop a standalone application using the KDE Platform
+
There are many different ways to become [http://community.kde.org/Getinvolved involved in the KDE Community], ranging all the way from a simply using our software through to being a core platform developer.
* Develop one of the KDE Applications
+
* Develop the KDE Workspace or the KDE Platform
+
* Test the latest KDE Software or an earlier stable version
+
  
In particular, for application development you may only need to build some parts of the KDE SC while relying on the KDE Platform stable packages from your distribution.
+
<!--T:6-->
 +
This section of KDE TechBase is designed to help get you started in participating in the technical side of the KDE community.  It will explain to you how KDE Software is structured and built, and how you can participate by building KDE for yourself.
  
The table below provides some guidance in making this decision, but before you start building please read the rest of the page for more detailed information on Getting Started.
+
== Using KDE Software == <!--T:8-->
  
<table border="1" width="100%" cellpadding="5">
+
<!--T:9-->
<tr>
+
If you just want to use stable KDE software for your everyday computing needs, then you do not need to build KDE Software for yourself. You should instead use the software installer provided by your Linux distribution to install KDE package.
  <td width="25%" style="background: #FFEFD3">'''Official Release'''
+
  <td width="25%" style="background: #FFFEE4">'''Nightly Build'''
+
  <td width="25%" style="background: #D0ECEA">'''Stable from Source'''
+
  <td width="25%" style="background: #9FD6D2">'''Master (Recommended)'''
+
<tr>
+
  <td>''For the casual user, or for application testers and developers who are working on applications outside of KDE SC''
+
  <td>''For application testers and developers who's applications require features from the unstable branch''
+
  <td>''For KDE SC and applications developers or testers that want to spend less time setting up a build system''
+
  <td>''For developers and testers working on core KDE SC functionality, and desire/need up-to-the-minute changes. Recommended for active developers.''
+
<tr>
+
  <td>Use a [[/Distribution_Packages|Distribution with KDE]] to set up a fully functional KDE system in one step. Also install the "developer packages" if you want to compile KDE software
+
  <td>Download and setup KDE SC on Kubuntu easily using [[Getting_Started/Using Project Neon to contribute to KDE|Project Neon]]
+
  <td>[[Getting_Started/Build/Stable|Build a Stable branch from source]]
+
  <td>[[Getting_Started/Build|Build KDE Software from Source]]
+
<tr>
+
</table>
+
  
== Getting Help ==
+
<!--T:10-->
If you have any questions or problems with building or developing KDE Software please feel free to [[Development/Getting_Help|ask for help]].  However, be patient while waiting for a response, and try to work through the problem yourself, we aren't just going to do it ''all'' for you and understanding why something doesn't work is a good way to learn how to do things the right way.
+
The best place to learn how to do this is through your distributions normal support channels, although you may find some useful information on the following pages:
 +
* [http://www.kde.org/download/distributions.php Distributions shipping KDE]
 +
* [[Special:myLanguage/Getting_Started/Build/Distributions|Install KDE Software on Linux and BSD Distributions]]
 +
* [[Special:myLanguage/Projects/KDE_on_Windows/Installation|Install KDE Software on Windows]]
 +
* Mac OS X does not currently have an installer available for KDE Software, but you can simplify building it by using [http://mac.kde.org/?id=build MacPorts or Fink]
  
== Source Repositories and Revision Control ==
+
== Getting Help == <!--T:11-->
KDE uses a common repository to store our Source Code and to track changes made to the code.  Currently, KDE is in the middle of migrating our main repository from Subversion (SVN) to Git, so some software modules will be downloaded from Git and some from Subversion.  This means you will need to become familiar with both systems.
+
  
For more information on using Git in KDE, please see the [[Development/Git|KDE Git]] page.
+
<!--T:12-->
 +
If you are looking for help in using the KDE Workspace or KDE Applications then please visit the [http://userbase.kde.org/ KDE UserBase].  
  
For more information on using Subversion, please see the following pages which may be outdated with regards to which modules live in SVN:
+
<!--T:13-->
* [[Getting_Started/Sources/Anonymous_SVN]]
+
If you have any questions or problems with building or developing KDE Software please feel free to [[Special:myLanguage/Development/Getting_Help|ask for help]].  However, be patient while waiting for a response, and try to work through the problem yourself, we aren't going to do it ''all'' for you.  Working your way through and understanding why something doesn't work is a good way to learn how to do things the right way.
* [[Getting_Started/Sources/Using_Subversion_with_KDE]]
+
  
== Development Tools ==
+
== Browsing the code == <!--T:28-->
There are a number of [[Development/Tools|Development Tools]] that are either required or helpful when building KDE Software. For these you will usually want to use the stable packages provided by your distribution.
+
The KDE project is all free and open source. You can view its source code and make changes.
  
You may want to use an graphical IDE for your development:
+
<!--T:29-->
* [http://www.kdevelop.org/ KDevelop 4]
+
http://projects.kde.org hosts the source for many KDE-related initiatives, including [https://projects.kde.org/projects/kde KDE itself].  Choose a piece of KDE such as KDE Libraries, then click Repository to browse its source. [[Getting_Started/Sources]] explains the organization of KDE source code.
* [[Development/Tools/Eclipse|Eclipse]]
+
* [[/Using_an_IDE_with_KDE4]]
+
  
== Building KDE ==
+
<!--T:30-->
 +
There are other utilities to browse the source code:
  
Instructions for building all or part of KDE SC on all the supported platforms can be found at [[Getting_Started/Build|Building KDE SC]]
+
<!--T:31-->
 +
* http://lxr.kde.org/search lets you search the code ''(may be out of date?)''
 +
* http://api.kde.org lets you browse API documentation generated from the code. You can search for class names, but not filenames.
  
== Running KDE ==
+
== Building and Running KDE Software From Source == <!--T:14-->
 +
 
 +
<!--T:15-->
 +
There are several possible ways to build and install KDE software and the method you choose depends on what you want to do with the software.  In particular if you are only wanting to build and develop a single application you may not need to build the entire KDE Development Platform to do so.  You can read more about this on the [[Special:myLanguage/Getting_Started/Build/Methods|Build Methods page]].
 +
 
 +
<!--T:33-->
 +
If you simply want to build one application, the simple tutorial [[Development/Tutorials/Building_An_Existing_Application|Building an Existing Application]] might be enough already.
 +
 
 +
<!--T:7-->
 +
{{Note|'''Quickstart:''' If you are impatient to get started without understanding what you are doing then you can skip straight to using a [[Special:myLanguage/Getting_Started/Build#Scripted_Builds|Build Script]], but it is strongly recommended you read this documentation first.}}
 +
 
 +
<!--T:32-->
 +
<!-- what about https://launchpad.net/project-neon that used to be linked here in 2010, does that still apply? - User:Skierpage -->
 +
 
 +
<!--T:16-->
 +
The following sections explain the steps you need to understand and give the instructions you need to follow to successfully build KDE Software from source:
 +
 
 +
<!--T:17-->
 +
* [[Special:myLanguage/Getting_Started/Sources|How the KDE Source Code is structured]]
 +
* [[Special:myLanguage/Getting_Started/Build|How to Build and Install the software]]
 +
* [[Special:myLanguage/Getting_Started/Run/Nested_Session|How to Run a nested session of KDE]]
 +
* [[Special:myLanguage/Getting_Started/Run/Full_Session|How to Run a full session of KDE]]
 +
 
 +
== Development Model == <!--T:18-->
 +
 
 +
<!--T:19-->
 +
TODO: General introduction to the dev model, release cycles, etc.
 +
 
 +
<!--T:20-->
 +
* [[Special:myLanguage/Schedules/Release_Schedules_Guide|The KDE Release Schedule]]
 +
* [[Special:myLanguage/Development/Software_Engineering_Framework|The KDE Software Engineering Framework]]
 +
* [[Special:myLanguage/Policies|KDE Development Policies and Procedures to follow]]
 +
* [[Special:myLanguage/Policies/Application_Lifecycle|The development lifecycle for a new application]]
 +
 
 +
== Development Tools == <!--T:21-->
 +
 
 +
<!--T:22-->
 +
There are a number of [[Special:myLanguage/Development/Tools|Development Tools]] that are either required or helpful when building KDE Software.  For these you will usually want to use the stable packages provided by your distribution.
 +
 
 +
<!--T:23-->
 +
You may want to use a graphical IDE for your development work:
 +
* [[Special:myLanguage/Development/Tutorials/Using_Qt_Creator|Qt Creator]]
 +
* [http://www.kdevelop.org/ KDevelop 4]
 +
* [[Special:myLanguage/Development/Tools/Eclipse|Eclipse]]
 +
* [[Special:myLanguage/Getting_Started/Using_an_IDE_with_KDE4|Using an IDE with KDE4]]
  
Once you have built the KDE Software, you will normally run the required applications directly from the command line using your configured build environment.  If you need to run the development Workspace or KDM then you will need to use other [[/Run|options to run KDE]].  Please note these pages are very outdated.
+
== Contributing To KDE == <!--T:24-->
  
== Contributing To KDE ==
+
<!--T:25-->
 
Once you have a copy of KDE built you can then start contributing back to KDE.  The pages below will help you find out how you can help make KDE even better.
 
Once you have a copy of KDE built you can then start contributing back to KDE.  The pages below will help you find out how you can help make KDE even better.
  
 +
<!--T:26-->
 
[[Image:Action_tool.svg|right|32px]]
 
[[Image:Action_tool.svg|right|32px]]
* [[Contribute|Contribute]]
+
* [[Special:myLanguage/Contribute|Contribute]]
* [[Contribute/Send_Patches|Send Patches]]
+
* [[Special:myLanguage/Contribute/Send_Patches|Send Patches]]
* [[Contribute/Bugsquad|Bugsquad]]
+
* [[Special:myLanguage/Contribute/Bugsquad|Bugsquad]]
  
 +
<!--T:27-->
 
[[Category:Build_KDE]]
 
[[Category:Build_KDE]]
 +
</translate>

Revision as of 06:06, 23 December 2012

Other languages:Greek 62% • ‎English 100% • ‎Finnish 62% • ‎French 98% • ‎Japanese 76% • ‎Korean 86% • ‎Dutch 78% • ‎Brazilian Portuguese 100% • ‎Russian 73% • ‎Turkish 46% • ‎Chinese (China) 47%
noframe
 
Warning
These pages are currently being completely re-written to reflect the new KDE infrastructure and may not be in a consistent state. Information and commands on some page may no longer be valid and should be used with care.


Contents

Introduction

There are many different ways to become involved in the KDE Community, ranging all the way from a simply using our software through to being a core platform developer.

This section of KDE TechBase is designed to help get you started in participating in the technical side of the KDE community. It will explain to you how KDE Software is structured and built, and how you can participate by building KDE for yourself.

Using KDE Software

If you just want to use stable KDE software for your everyday computing needs, then you do not need to build KDE Software for yourself. You should instead use the software installer provided by your Linux distribution to install KDE package.

The best place to learn how to do this is through your distributions normal support channels, although you may find some useful information on the following pages:

Getting Help

If you are looking for help in using the KDE Workspace or KDE Applications then please visit the KDE UserBase.

If you have any questions or problems with building or developing KDE Software please feel free to ask for help. However, be patient while waiting for a response, and try to work through the problem yourself, we aren't going to do it all for you. Working your way through and understanding why something doesn't work is a good way to learn how to do things the right way.

Browsing the code

The KDE project is all free and open source. You can view its source code and make changes.

http://projects.kde.org hosts the source for many KDE-related initiatives, including KDE itself. Choose a piece of KDE such as KDE Libraries, then click Repository to browse its source. Getting_Started/Sources explains the organization of KDE source code.

There are other utilities to browse the source code:

Building and Running KDE Software From Source

There are several possible ways to build and install KDE software and the method you choose depends on what you want to do with the software. In particular if you are only wanting to build and develop a single application you may not need to build the entire KDE Development Platform to do so. You can read more about this on the Build Methods page.

If you simply want to build one application, the simple tutorial Building an Existing Application might be enough already.

noframe
 
Note
Quickstart: If you are impatient to get started without understanding what you are doing then you can skip straight to using a Build Script, but it is strongly recommended you read this documentation first.


The following sections explain the steps you need to understand and give the instructions you need to follow to successfully build KDE Software from source:

Development Model

TODO: General introduction to the dev model, release cycles, etc.

Development Tools

There are a number of Development Tools that are either required or helpful when building KDE Software. For these you will usually want to use the stable packages provided by your distribution.

You may want to use a graphical IDE for your development work:

Contributing To KDE

Once you have a copy of KDE built you can then start contributing back to KDE. The pages below will help you find out how you can help make KDE even better.

Action tool.svg

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