Difference between revisions of "Getting Started"

Jump to: navigation, search
(T36 : locate alignment of '/build' sub page (impacted the translated pages))
 
(79 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Getting_Started}}
+
<languages />
  
{{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. }}
 
  
== Introduction ==
+
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!
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. In particular, you may only need to build parts of the KDE SC.  The table below provides some guidance in making this decision, but before you start please read the rest of the page for more detailed information on Getting Started.
 
  
<table border="1" width="100%" cellpadding="5">
+
<translate>
<tr>
+
<!--T:35-->
  <td width="25%" style="background: #FFEFD3">'''Official Release'''
+
{{Note|
  <td width="25%" style="background: #FFFEE4">'''Nightly Build'''
+
To contribute to KDE, see [https://community.kde.org/Get_Involved the Get Involved page on the Community Wiki].
  <td width="25%" style="background: #D0ECEA">'''Stable from Source'''
 
  <td width="25%" style="background: #9FD6D2">'''Master (Recommended)'''
 
<tr>
 
  <td>''For the casual user, or a developer who is working on applications outside of KDE SC''
 
  <td>''For application developers or package managers who are not modifying the core of KDE SC''
 
  <td>''For KDE SC and applications developers that want to spend less time setting up a build system''
 
  <td>''For developers working on core KDE SC functionality, and desire/need up-to-the-minute changes. Recommended for very active developers.''
 
<tr>
 
  <td rowspan=4>1. Use a [[Distributions with KDE|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>1. Install [[Getting_Started/Build/Requirements|Build Requirements]] from your distribution
 
  <td>1. Install [[Getting_Started/Build/Requirements|Build Requirements]] from your distribution
 
  <td>1. Install [[Getting_Started/Build/Requirements|Build Requirements]] from your distribution
 
<tr>
 
  <td rowspan=3>2. Download and setup KDE SC on Kubuntu easily using [[Getting_Started/Using Project Neon to contribute to KDE|Project Neon]]
 
  <td>2. Download KDE sources from [[Getting_Started/Sources/Anonymous_SVN|SVN]]
 
  <td rowspan=2>3. [[Getting_Started/Build/KDE4|Download and Build KDE SC from Git]]
 
<tr>
 
  <td>3. [[Getting_Started/Build/KDE4.x|Build a stable 4.x release]]
 
<tr>
 
  <td>4. [[Getting_Started/Set_up_KDE_4_for_development|Set up scripts]] to ease KDE development
 
  <td>4. [[Getting_Started/Set_up_KDE_4_for_development|Set up scripts]] to ease KDE development
 
</table>
 
  
== Getting Help ==
+
<!--T:36-->
If you have any questions or issues related to building and developing KDE feel free to [[Development/Getting_Help|ask us]]. However, be patient and do expect to be attempting to work through the issue as well (we aren't just going to do it ''all'' for you).
+
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]].
 +
}}
 +
</translate>
  
== Source Repositories and Revision Control ==
+
= Setting Up =
TODO: Short intro to the subject, why's and where's, link to other pages.
 
  
Currently, KDE SC source code is for the most part, accessed using git. For those modules that are still in svn, consult: [[Getting_Started/Sources/Anonymous_SVN]].
+
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.
  
[[Getting_Started/Sources/Amarok_Git_Tutorial|Amarok has already migrated to Git]], as well as many other modules modules (phonon, parts of kdesupport, kdelibs, kdebase, kdeplasma-addons). Until we are fully migrated at least, it is recommended to use kdesrc-build if you can, as it takes care of all of this for you.
+
= KDE Frameworks =
 +
'''[[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.
  
== Development Tools ==
+
* [https://www.kde.org/products/frameworks/ KDE Frameworks Product page]
You will likely want to use a stable package from your distribution instead of the ones of the KDE version you are working on.
+
* [[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]]
  
For most development topics, and documentation, see [[Development]]
+
= Kirigami =
 +
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.
  
; Opening and creating KDE project files
+
* [https://kde.org/products/kirigami/ Kirigami landing page]
* [[eclipse|Eclipse]]
+
* [https://api.kde.org/frameworks/kirigami/html/index.html Kirigami API documentation]
* [[KDevelop 4]]
+
* Kirigami on [[Kirigami|TechBase]] and the [[Community:Kirigami|Community Wiki]]
* [[Development/Tutorials/Using_Qt_Designer|Qt Designer]]
 
  
== Building KDE ==
+
= 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.
  
[[Getting_Started/Build]]
+
* [[Development/Tutorials|Development Tutorials]]
 +
* [[Development|TechBase Development Hub]]
 +
* [[Community:Get_Involved|Get involved with the KDE Community]]
  
* [[Getting_Started/Using Project Neon to contribute to KDE|Using Project Neon to contribute to KDE]]
+
= Plasma =
* [[Getting_Started/EasyStartDevelopmentOnDebian | Build, change and run packaged KDE applications on Debian]]
+
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.
  
=== Other Platforms ===
+
* [https://kde.org/plasma-desktop.php Plasma Desktop website]
KDE can also be built on platforms other than Linux. For more details please see the relevant page.
+
* [[Development/Tutorials/Plasma5|Plasma Tutorials]]
 +
* [https://www.plasma-mobile.org/ Plasma Mobile website]
  
[[Getting_Started/Build|other supported platforms]]
+
= 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.
  
* Windows
+
* 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.
* Mac OSX
+
* 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.
* BSD
+
* 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.
  
=== KDE 3 ===
 
KDE3 is no longer supported, but some documentation on building it still exists.
 
  
== Contributing To KDE ==
+
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.
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.
 
  
[[Image:Action_tool.svg|right|32px]]
 
* [[Contribute|Contribute]]
 
* [[Contribute/Send_Patches|Send Patches]]
 
* [[Contribute/Bugsquad|Bugsquad]]
 
  
[[Category:Build_KDE]]
+
[[Category:Needs_Attention]]

Latest revision as of 13:09, 20 August 2019

Other languages:
English • ‎Nederlands • ‎Türkçe • ‎français • ‎português do Brasil • ‎suomi • ‎Ελληνικά • ‎русский • ‎中文(中国大陆)‎ • ‎日本語 • ‎한국어


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-box-icon.png
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.


This page was last edited on 20 August 2019, at 13:09. Content is available under Creative Commons License SA 4.0 unless otherwise noted.