Getting Started: Difference between revisions

    From KDE TechBase
    No edit summary
    (115 intermediate revisions by 21 users not shown)
    Line 1: Line 1:
    {{Template:I18n/Language Navigation Bar|Getting_Started}}
    <languages />
    <translate>


    == Determine Your Needs==
    <!--T:1-->
    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]].  
    {{Warning|These build instructions are outdated as of 2012. Please visit irc://chat.freenode.net/kde-devel for assistance building. Then please come back here to help update these files.}}


    === Version ===
    == Introduction == <!--T:3-->
    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.


    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.
    <!--T:4-->
    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.


    [[Getting_Started/Build|Other versions and FAQ]] ''Including information for building on non-linux systems Incl KDE3''
    <!--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.


    To See which versions/branches of KDE are available go to:
    == Using KDE Software == <!--T:8-->
    ::http://websvn.kde.org/branches/KDE/


    <!--T:9-->
    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.


    === Location ===
    <!--T:10-->
    It is possible to install KDE in a variety of ways. Instructions should be listed with each build method, however much is common between methods and reading all may be required. Note that if using system Qt for a user based KDE install, the [[QCA plugin]] may have to be installed as root)
    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://community.kde.org/Mac#Installing_KDE_on_Mac_OSX MacPorts, Fink or Homebrew]


    ; development user home
    == Getting Help == <!--T:11-->
    This is a common way to do it so that it does not interefere with your production user and the rest of the system. A common user name is kde-devel. This is recommended for the cautious testers and developers. You can still use [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|scripts]] to switch between system and regular.


    ; your home directory
    <!--T:12-->
    Useful on development machines, or if you have no other access to the machine, you will have to set environment variables to switch between system and user versions of KDE, There are some [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts|scripts]]  to help you use it. And switching back and forth between versions of a program are likely to corrupt your data.
    If you are looking for help in using the KDE Workspace or KDE Applications then please visit the [http://userbase.kde.org/ KDE UserBase].  


    ; system-wide
    <!--T:13-->
    on development systems, do it to test KDM and other system level KDE functionalityThis is normal 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.
    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 youWorking your way through and understanding why something doesn't work is a good way to learn how to do things the right way.


    === Method ===
    == Browsing the code == <!--T:28-->
    The KDE project is all free and open source. You can view its source code and make changes.


    Regardless of method chosen, reading up on the manual steps below will be very helpful.
    <!--T:29-->
    [[Development/CMake|CMake]] may also be of interest.
    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.


    ; Fully Manual
    <!--T:30-->
    ; Distribution Specific
    There are other utilities to browse the source code:
    ; Augmented (Recommended)
    : Manual, but with a few scripts to keep everything easy
    ; KDEsrc-build
    : Useful for automated builds, may be tough to set up


    == Gather Prerequisites ==
    <!--T:31-->
    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.
    * 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.


    * [[Getting_Started/Build/KDE4/Prerequisites]]
    == Building and Running KDE Software From Source == <!--T:14-->
    * [[build requirements]] by distribution


    == Build it ==
    <!--T:15-->
    ; Most used method, augmented with bash functions.
    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]].
    [[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts]]  


    ; Manual Steps
    <!--T:33-->
    * [[Getting_Started/Build/KDE4|KDE 4 (Development version, TRUNK)]]
    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.
    * [[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|Other versions and FAQ]] ''Including information for building on non-linux systems''


    ; distribution specific
    <!--T:7-->
    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.  
    {{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.}}


    ; kdesrc-build
    <!--T:32-->
    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 [[Getting_Started/Build/kdesrc-build|kdesrc-build]], and here is a list of [[kdesrc-build/workingrclist|working configuration files]].
    <!-- what about https://launchpad.net/project-neon that used to be linked here in 2010, does that still apply? - User:Skierpage -->


    * This will compile qt for you, or you can configure it to use system QT
    <!--T:16-->
    * When you choose a branch
    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:
    ** 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==
    <!--T:17-->
    [[Image:Action_down.svg|right|32px]]
    * [[Special:myLanguage/Getting_Started/Sources|How the KDE Source Code is structured]]
    * [[Getting_Started/Sources/Anonymous SVN|Anonymous SVN Quickstart Guide]]
    * [[Special:myLanguage/Getting_Started/Build|How to Build and Install the software]]
    * [[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.''
    * [[Special:myLanguage/Getting_Started/Run/Nested_Session|How to Run a nested session of KDE]]
    * [[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.''
    * [[Special:myLanguage/Getting_Started/Run/Full_Session|How to Run a full session of KDE]]
    * [[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 ==
    == Development Model == <!--T:18-->
    * [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]


    [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]] information is similar between branches as well.
    <!--T:19-->
    TODO: General introduction to the dev model, release cycles, etc.


    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. 
    <!--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]]


    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]]
    == Development Tools == <!--T:21-->


    ==Using your KDE==
    <!--T:22-->
    After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:
    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.
    ; Environment Variables
    Your system won't know to use your new KDE until you tell it how to find the KDE applications and libraries.
    [[Image:Action_pen.svg|right|32px]]
    * [[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]]


    ==Set up Development Tools==
    <!--T:23-->
    You may need to set up or use, you will likely want to use a stable package from your distribution.
    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]]


    it is unclear if the kde-devel user or your normal user will be running the development tools. Please Help
    == Contributing To KDE == <!--T:24-->


    For most development topics, and documentation, see [[Development]]
    <!--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.
    ; Opening and creating KDE project files
    * [[eclipse]]
    * [[kdevelop]]
    * [[qtdesigner]]
     
       
    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.


    <!--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]]
    * [[Getting_Started/Using Project Neon to contribute to KDE|Using Project Neon to contribute to KDE]]
     


    <!--T:27-->
    [[Category:Build_KDE]]
    [[Category:Build_KDE]]
    </translate>

    Revision as of 23:01, 15 December 2014

    Warning
    These build instructions are outdated as of 2012. Please visit irc://chat.freenode.net/kde-devel for assistance building. Then please come back here to help update these files.


    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.

    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.