Getting Started: Difference between revisions

    From KDE TechBase
    No edit summary
    (134 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 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 ,[[Getting_Started/Build/KDE4/Prerequisites|prerequisites]] or  [[build requirements]]for your distribtion.
    <!--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.


    For developers, The TRUNK is the main branch where new features (and prerequisites) are added, however it can be difficult to keep up with.
    <!--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.


    [[Getting_Started/Build|Other versions and FAQ]] ''Including information for building on non-linux systems Incl KDE3''
    == Using KDE Software == <!--T:8-->


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


    ; development user home
    <!--T:10-->
    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. This is recommended for most testers and developers.
    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]


    ; your home directory
    == Getting Help == <!--T:11-->
    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.


    ; system-wide
    <!--T:12-->
    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.
    If you are looking for help in using the KDE Workspace or KDE Applications then please visit the [http://userbase.kde.org/ KDE UserBase].  


    === Method ===
    <!--T:13-->
    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.


    Regardless of method chosen, reading up on the manual steps below will be very helpful.
    == Browsing the code == <!--T:28-->
    [[Development/CMake|CMake]] may also be of interest.
    The KDE project is all free and open source. You can view its source code and make changes.


    ; distribution specific
    <!--T:29-->
    If you use Kubuntu, consider Project Neon, where you may be able to download recent-enough Trunk Kubuntu packages and build enviornment.
    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.


    ; kdesrc-build
    <!--T:30-->
    This script will do most of the downloading and compiling for you. There are  
    There are other utilities to browse the source code:
    good instructions at http://kdesrc-build.kde.org


    You can configure [[Getting_Started/Build/kdesrc-build|kdesrc-build]] to build most versions.  
    <!--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.


    * You will likely want to choose a recent branch
    == Building and Running KDE Software From Source == <!--T:14-->
    * If you choose a branch, you will have to tweak the kdeSupport module description in the .kdesrc-buildrc


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


    ; 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''


    ==Getting the Source==
    <!--T:7-->
    [[Image:Action_down.svg|right|32px]]
    {{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.}}
    * [[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 ==
    <!--T:32-->
    * [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]
    <!-- what about https://launchpad.net/project-neon that used to be linked here in 2010, does that still apply? - User:Skierpage -->


    [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]] information is similar between branches as well.
    <!--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:


    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: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]]


    Please review your logs and do searches for fixes. If you cannot find a solution, [[Build/KDE4/Errors]] and IRC channel, and mailing lists.
    == Development Model == <!--T:18-->


    ==Using your KDE==
    <!--T:19-->
    After KDE has been built, you'll want a good way to launch apps and perform your regular development tasks:
    TODO: General introduction to the dev model, release cycles, etc.
    ; 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]]


    ==Development Tools==
    <!--T:20-->
    You may need to set up or use, you will likely want to use a stable package from your distribution.
    * [[Special:myLanguage/Schedules/Release_Schedules_Guide|The KDE Release Schedule]]
    * eclipse
    * [[Special:myLanguage/Development/Software_Engineering_Framework|The KDE Software Engineering Framework]]
    * kdevelop
    * [[Special:myLanguage/Policies|KDE Development Policies and Procedures to follow]]
    * qtdesigner
    * [[Special:myLanguage/Policies/Application_Lifecycle|The development lifecycle for a new application]]


    ; Opening and creating KDE project files
    == Development Tools == <!--T:21-->
    This is a stub, please help.


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


    ==Contribution==
    <!--T:23-->
    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.
    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]]


    == Contributing To KDE == <!--T:24-->
    <!--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.
    <!--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.