Getting Started: Difference between revisions

From KDE TechBase
(level 1 is reserved for the page name; starting with level 2; indentation follows other sections)
 
(132 intermediate revisions by 29 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Getting_Started}}
<languages /><translate>


== Determine Your Needs==
== Getting Started on TechBase == <!--T:37-->
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]].


=== [[Choose Version]] ===
<!--T:38-->
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.
The KDE community is perhaps best known for its Plasma desktop workspace as well as its rich collection of applications but the community has also produced libraries and tools to make software development more enjoyable or, at the very least, less painful. Whether you're looking to write you first KDE application, make your existing Qt project more awesome, or get involved with one or more of the great KDE projects, this is a great place to get your journey started!


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 versions and FAQ]] ''Including information for building on non-linux systems Incl KDE3''
<!--T:35-->
{{Note|
To contribute to KDE, see [https://community.kde.org/Get_Involved the Get Involved page on the Community Wiki].


To See which versions/branches of KDE are available go to:
<!--T:36-->
::http://websvn.kde.org/branches/KDE/
If you are looking for build instructions, [https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source up-to-date build instructions] are available  on the Community Wiki, and we also have [[{{BASEPAGENAME}}/Build/Historic|historic ones]].
}}


=== Location ===
== Setting Up == <!--T:39-->
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)
Getting started can be as simple or as involved as you need it to be. As much as possible, use your distro's packages to simply and speed up development unless you really need to get the latest source code version. And no, you don't need to "compile all of KDE" just to use a single framework. Not convinced? Check out our [[Development/Tutorials/Setting_Up|Setting Up Guide]] to see how easy it can be.


; development user home
== KDE Frameworks == <!--T:40-->
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.
'''[[Frameworks|KDE Frameworks 5]]''' is built on top of the excellent Qt application framework to provide more functionality and power to your next big project. KDE software developers will also find classes that help them better integrate their applications into the Plasma workspace and with other KDE products.


; your home directory
<!--T:41-->
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.
* [https://www.kde.org/products/frameworks/ KDE Frameworks Product page]
* [[Development/Tutorials#Basics_of_how_to_develop_with_KDE_Frameworks|Tutorials to get started with KF5]]
* [https://api.kde.org/frameworks/index.html KDE Frameworks 5 API Documentation]
* KDE Frameworks on [[Frameworks|TechBase]] and the [[Community:Frameworks|Community Wiki]]


; system-wide
== Kirigami == <!--T:42-->
on development systems, do it to test KDM and other system level KDE functionality. This 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.
Named after the Japanese art of cutting and folding paper to create beautiful objects, the '''[[Kirigami|Kirigami framework]]''' offers components to let your piece together a beautiful and responsive application. Expanding the Qt Quick framework, Kirigami empowers developers to create apps that look and behave well on desktop, mobile, and more.


=== Method ===
<!--T:43-->
* [https://kde.org/products/kirigami/ Kirigami landing page]
* [https://api.kde.org/frameworks/kirigami/html/index.html Kirigami API documentation]
* Kirigami on [[Kirigami|TechBase]] and the [[Community:Kirigami|Community Wiki]]


Regardless of method chosen, reading up on the manual steps below will be very helpful.
== Tutorials == <!--T:44-->
[[Development/CMake|CMake]] may also be of interest.
Get your feet wet or dive head first into coding with KDE's collection of '''Tutorials'''. From writing your first application using the KDE Frameworks to developing applets for the Plasma workspace, these bite-sized guides will get you up and running in no time.


; Fully Manual
<!--T:45-->
; Distribution Specific
* [[Development/Tutorials|Development Tutorials]]
; Augmented (Recommended)
* [[Development|TechBase Development Hub]]
: Manual, but with a few scripts to keep everything easy
* [[Community:Get_Involved|Get involved with the KDE Community]]
; KDEsrc-build
: Useful for automated builds, may be tough to set up


== Gather Prerequisites ==
== Plasma == <!--T:46-->
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.
KDE's world-famous workspace for desktops and mobile, '''Plasma''' provides a rich set of building blocks to help developers create rich, beautiful, and productive user experiences on different devices, form-factors, and use cases. [[Projects/KWin|KWin]] is one of the most powerful and most flexible window managers around, providing advanced functionality and control on both X11 and Wayland systems.


* [[Getting_Started/Build/KDE4/Prerequisites]]
<!--T:47-->
* [[build requirements]] by distribution
* [https://kde.org/plasma-desktop.php Plasma Desktop website]
* [[Development/Tutorials/Plasma5|Plasma Tutorials]]
* [https://www.plasma-mobile.org/ Plasma Mobile website]


== Build it ==
== It's just the beginning == <!--T:48-->
; Most used method, augmented with bash functions.
These are just the large tips of the KDE iceberg. The community has developed many libraries for more specific needs and use cases that developers can also use to simplify their projects.
[[Getting_Started/Increased_Productivity_in_KDE4_with_Scripts]]


; Manual Steps
<!--T:49-->
* [[Getting_Started/Build/KDE4|KDE 4 (Development version, TRUNK)]]
* Need an easy and cross-platform way to handle audio and video? [[Phonon]]'s API will be very familiar to Qt developers and supports multiple backends, including GStreamer, VLC, and anything else you might want to develop.
* [[Getting_Started/Build/KDE4.x|KDE 4.x (Stable version or 4.x SVN BRANCH)]]
* If you need a privacy-respecting way to display maps and even the whole world, [[Marble]] provides data models and widgets to make that a walk in the park.
* [[Getting_Started/Build/KDE4.4 Upgrade|Upgrade KDE-4.4.x release version or KDE-4.4 SVN BRANCH)]]
* If you need libraries for handling email, events, and more, the [[KDE PIM]] libraries have withstood not only the test of time but also the test of enterprise customers.
* [[Getting_Started/Build|Other versions and FAQ]] ''Including information for building on non-linux systems''


; 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
<!--T:50-->
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]].
Check out the other KDE Projects that provide libraries and APIs that you can use to boost your own projects. The KDE Community is also welcoming not just new contributors but also new projects that want to be part of one of the biggest free software communities on the planet.
</translate>


* 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==
[[Category:Needs_Attention]]
[[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 ==
* [[Getting_Started/Build/KDE4/Troubleshooting|Troubleshooting]]
 
[[Getting_Started/Build/KDE4/Troubleshooting|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.
[[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==
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
* [[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.
 
[[Image:Action_tool.svg|right|32px]]
* [[Contribute|Contribute]]
* [[Contribute/Send_Patches|Send Patches]]
* [[Contribute/Bugsquad|Bugsquad]]
* [[Getting_Started/Using Project Neon to contribute to KDE|Using Project Neon to contribute to KDE]]
 
 
[[Category:Build_KDE]]

Latest revision as of 15:50, 7 September 2020

Other languages:

Getting Started on TechBase

The KDE community is perhaps best known for its Plasma desktop workspace as well as its rich collection of applications but the community has also produced libraries and tools to make software development more enjoyable or, at the very least, less painful. Whether you're looking to write you first KDE application, make your existing Qt project more awesome, or get involved with one or more of the great KDE projects, this is a great place to get your journey started!


Note
To contribute to KDE, see the Get Involved page on the Community Wiki. If you are looking for build instructions, up-to-date build instructions are available on the Community Wiki, and we also have historic ones.


Setting Up

Getting started can be as simple or as involved as you need it to be. As much as possible, use your distro's packages to simply and speed up development unless you really need to get the latest source code version. And no, you don't need to "compile all of KDE" just to use a single framework. Not convinced? Check out our Setting Up Guide to see how easy it can be.

KDE Frameworks

KDE Frameworks 5 is built on top of the excellent Qt application framework to provide more functionality and power to your next big project. KDE software developers will also find classes that help them better integrate their applications into the Plasma workspace and with other KDE products.

Kirigami

Named after the Japanese art of cutting and folding paper to create beautiful objects, the Kirigami framework offers components to let your piece together a beautiful and responsive application. Expanding the Qt Quick framework, Kirigami empowers developers to create apps that look and behave well on desktop, mobile, and more.

Tutorials

Get your feet wet or dive head first into coding with KDE's collection of Tutorials. From writing your first application using the KDE Frameworks to developing applets for the Plasma workspace, these bite-sized guides will get you up and running in no time.

Plasma

KDE's world-famous workspace for desktops and mobile, Plasma provides a rich set of building blocks to help developers create rich, beautiful, and productive user experiences on different devices, form-factors, and use cases. KWin is one of the most powerful and most flexible window managers around, providing advanced functionality and control on both X11 and Wayland systems.

It's just the beginning

These are just the large tips of the KDE iceberg. The community has developed many libraries for more specific needs and use cases that developers can also use to simplify their projects.

  • Need an easy and cross-platform way to handle audio and video? Phonon's API will be very familiar to Qt developers and supports multiple backends, including GStreamer, VLC, and anything else you might want to develop.
  • If you need a privacy-respecting way to display maps and even the whole world, Marble provides data models and widgets to make that a walk in the park.
  • If you need libraries for handling email, events, and more, the KDE PIM libraries have withstood not only the test of time but also the test of enterprise customers.


Check out the other KDE Projects that provide libraries and APIs that you can use to boost your own projects. The KDE Community is also welcoming not just new contributors but also new projects that want to be part of one of the biggest free software communities on the planet.

Retrieved from "https://techbase.kde.org/index.php?title=Getting_Started&oldid=106539"