Difference between revisions of "Getting Started"

Jump to: navigation, search
(Add preliminary content for new Getting Started)
(76 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|Getting_Started}}  
+
{{Under_Construction}}
  
{{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. }}
+
<languages />
 +
<translate>
 +
<!--T:35-->
 +
See [https://community.kde.org/Get_Involved the Get Involved page on the Community Wiki].
  
==Preface==
+
<!--T:36-->
 +
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 [[/Build/Historic|historic ones]].
 +
</translate>
  
 +
{{Warning|Work in progress. Do not translate yet.}}
  
== Installing KDE SC and its Prerequesites ==
+
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 ways to install KDE SC so that you can use and develop KDE software. Below are complete instructions for installing KDE4 on a Linux system based on whether you want an Official Release, a Nightly Build, Stable 4.x Release, or Master (master is the git equivalent to what was called "trunk". It is the most recent snapshot.
+
  
<table border="1" width="100%" cellpadding="5">
+
Setup?
<tr>
+
  <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 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]] from your distribution
+
  <td>1. Install [[Getting_Started/Build/Requirements]] from your distribution
+
  <td>1. Install [[Getting_Started/Build/Requirements]] from your distribution
+
<tr>
+
  <td rowspan=3>2. Download and setup KDE SC 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>
+
For instructions on installing KDE SC on Windows, BSD, or Mac OS X, or instructions for installing KDE3, please see the [[Getting_Started/Build|other supported platforms]] page. There are also [[Getting_Started/Build/KDE4.x_Upgrade|upgrade instructions from a branch to trunk]].
+
  
Below is additional information you may be interested in before installing KDE.
+
'''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.
  
== Getting Help ==
+
- Page
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).
+
- apidocs
 +
- tutorials
  
== Source Repositories and Revision Control ==
+
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.
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/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.
+
- website
 +
- HIG
 +
- apidocs
  
== Development Tools ==
+
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.
You will likely want to use a stable package from your distribution instead of the ones of the KDE version you are working on.
+
  
For most development topics, and documentation, see [[Development]]
+
- Tutorials
 +
- Tools
  
; Opening and creating KDE project files
+
KDE's world-famous worskpace 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.
* [[eclipse|Eclipse]]
+
* [[KDevelop 4]]
+
* [[Development/Tutorials/Using_Qt_Designer|Qt Designer]]
+
  
== Building KDE ==
+
- Plasma
 +
- KWin
 +
- Plasma Mobile
  
[[Getting_Started/Build]
+
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.
  
== Contributing To KDE ==
+
- 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.
You probably won't need the latest bleeding-edge version of KDE with which to develop.  Much of the code will be similar between versions and your patch might work.
+
  
Follow the next articles to find out how to help us make KDE better ;-)
+
- 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.
  
[[Image:Action_tool.svg|right|32px]]
+
- 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.
* [[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]]
+
* [[Getting_Started/EasyStartDevelopmentOnDebian | Build, change and run packaged KDE applications on Debian]]
+
  
[[Category:Build_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.
 +
 
 +
 
 +
[[Category:Needs_Attention]]

Revision as of 08:17, 19 May 2019

noframe
 
Under Construction
This page is under construction. This page is actively being developed and updated with new information, and may be incomplete. You can help by editing this page


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

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.

noframe
 
Warning
Work in progress. Do not translate yet.


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!

Setup?

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.

- Page - apidocs - tutorials

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.

- website - HIG - apidocs

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.

- Tutorials - Tools

KDE's world-famous worskpace 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.

- Plasma - KWin - Plasma Mobile

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.


Content is available under Creative Commons License SA 4.0 unless otherwise noted.