KDevelop4/Manual/Getting started: Difference between revisions

From KDE UserBase Wiki
mNo edit summary
(modified image display)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
== First steps ==
{{Construction}}
{{Construction}}


First of all, before you can do anything, you need to install the software.
When you first start '''KDevelop''', you will see a pretty clean working window.
 
[[Image:kdevelop4_clean.png|thumb|500px|center|The clean KDevelop window]]
After installing the software, we start creating a simple C++ project using CMake as the build system. This will also include a very simple tutorial on CMake, as it is very well supported in KDevelop and very powerful.
 
== Getting packages ==
Start your favorite package manager and install kdevelop4. The dependencies like boost, qjson etc. should be solved automatically.
 
If you want to build KDevelop yourself, see [[KDevelop4/Manual/Appendix A: Building KDevelop from Sources|Appendix A: Building KDevelop from Sources]].
 
== First steps ==
When you first start KDevelop, you will see a pretty clean working window.
[[image:kdevelop4_clean.png|thumb|600px|center|The clean KDevelop window]]
<div style="float:right;padding:1em;"><gallery>
image:kdevelop4_new_cmake.png|Create a new CMake project
image:kdevelop4_builddir_config.png|Build directory configuration
</gallery></div>
Instead of explaining all the different areas, menus, tools, etc. of KDevelop, we'll jump into the cold water and start our C++ project.
Instead of explaining all the different areas, menus, tools, etc. of KDevelop, we'll jump into the cold water and start our C++ project.
{|class="tablecenter"
|[[Image:kdevelop4_new_cmake.png|200px|thumb|Create a new CMake project]]
|[[Image:kdevelop4_builddir_config.png|200px|thumb|Build directory configuration]]
|}
* Click on <menuchoice>Project -> New from Template...</menuchoice>
* Click on <menuchoice>Project -> New from Template...</menuchoice>
* Click on <menuchoice>C++ -> No GUI (CMake) -> Simple CMake-based C++ application</menuchoice>
* Click on <menuchoice>C++ -> No GUI (CMake) -> Simple CMake-based C++ application</menuchoice>
* KDevelop complains about an empty project name – so enter one!
* '''KDevelop''' complains about an empty project name – so enter one!
* Then click on "Next" and on "Finish"
* Then click on <menuchoice>Next</menuchoice> and on <menuchoice>Finish</menuchoice>
* You are asked for a configuration for the build directory – for now you can skip this dialog by clicking on "OK"
* You are asked for a configuration for the build directory – for now you can skip this dialog by clicking on <menuchoice>OK</menuchoice>


== Project management ==
== Project management ==
[[image:kdevelop4_projects_toolview.png|left|thumb|Projects Toolview]]
 
On the left side of the window, you see the ''Projects Toolview''. You can open multiple projects within one session - your currently opened projects will be displayed in that toolview.
[[Image:kdevelop4_projects_toolview.png|left|thumb|Projects Toolview]]
On the left side of the window, you see the '''Projects Toolview'''. You can open multiple projects within one session - your currently opened projects will be displayed in that toolview.


The upper part is basically a simple file browser where all files and build targets in your project's folder are listed.
The upper part is basically a simple file browser where all files and build targets in your project's folder are listed.
Line 32: Line 25:
You see that <code>main.cpp</code> is listed both under your project's folder as well as under your project's <code>make</code> target. This is pretty useful, as you can quickly see which files belong to which target, and which files you may have forgotten to add to a target.
You see that <code>main.cpp</code> is listed both under your project's folder as well as under your project's <code>make</code> target. This is pretty useful, as you can quickly see which files belong to which target, and which files you may have forgotten to add to a target.


The lower part of the Projects Toolview is your ''Projects Selection''. In this area you can add or remove all projects that should be built when you click on "Build Selection". With the "+" sign you can add projects from the upper part to the list, with the "-" sign you can remove them. If you have multiple projects in that list, you can change the order by using the arrow buttons to the right side of the list. Very useful when you have projects with inter-depencies.
The lower part of the Projects Toolview is your '''Projects Selection'''. In this area you can add or remove all projects that should be built when you click on "Build Selection". With the {{Plus}} you can add projects from the upper part to the list, with the {{Minus}} you can remove them. If you have multiple projects in that list, you can change the order by using the arrow buttons to the right side of the list. Very useful when you have projects with interdependencies.


You may have noticed the four icons and the text input field in the upper area. Let's go from left to right:
You may have noticed the four icons and the text input field in the upper area. Let's go from left to right:
* The first button with the double arrow is useful for huge projects - it navigates your file selection to the document that is currently opened in the editing area on the right side.
* The first button with the double arrow is useful for huge projects - it navigates your file selection to the document that is currently opened in the editing area on the right side.
* The second button with the gear builds your currently selected target or project.
* The second button with the gear builds your currently selected target or project.
* The third button with the gear and the small blue arrow installs your selection if you have install targets and rules defined - more details about that will be covered in the chapter about [[KDevelop4/Manual/Build Systems|Build Systems]].
* The third button with the gear and the small blue arrow installs your selection if you have install targets and rules defined - more details about that will be covered in the chapter about [[KDevelop4/Manual/Build Systems|Build Systems]].
* The last button cleans up your selected target by executing <code>make clean</code>.
* The last button cleans up your selected target by executing <code>make clean</code>.
* And finally, in the text field you can enter terms to filter the view. This does only work, if the search term you entered is at the start of any target, filename, or folder within your tree view.
* And finally, in the text field you can enter terms to filter the view. This does only work, if the search term you entered is at the start of any target, filename, or folder within your tree view.


{{KDevelop4Nav|next=Getting started: A small CMake tutorial}}
{{KDevelop4Nav|next=Getting started: A small CMake tutorial}}
[[Category:Tutorials]]

Latest revision as of 08:48, 15 September 2012

First steps

Under Construction

This is a new page, currently under construction!


When you first start KDevelop, you will see a pretty clean working window.

The clean KDevelop window

Instead of explaining all the different areas, menus, tools, etc. of KDevelop, we'll jump into the cold water and start our C++ project.

Create a new CMake project
Build directory configuration
  • Click on Project -> New from Template...
  • Click on C++ -> No GUI (CMake) -> Simple CMake-based C++ application
  • KDevelop complains about an empty project name – so enter one!
  • Then click on Next and on Finish
  • You are asked for a configuration for the build directory – for now you can skip this dialog by clicking on OK

Project management

Projects Toolview

On the left side of the window, you see the Projects Toolview. You can open multiple projects within one session - your currently opened projects will be displayed in that toolview.

The upper part is basically a simple file browser where all files and build targets in your project's folder are listed.

You see that main.cpp is listed both under your project's folder as well as under your project's make target. This is pretty useful, as you can quickly see which files belong to which target, and which files you may have forgotten to add to a target.

The lower part of the Projects Toolview is your Projects Selection. In this area you can add or remove all projects that should be built when you click on "Build Selection". With the you can add projects from the upper part to the list, with the you can remove them. If you have multiple projects in that list, you can change the order by using the arrow buttons to the right side of the list. Very useful when you have projects with interdependencies.

You may have noticed the four icons and the text input field in the upper area. Let's go from left to right:

  • The first button with the double arrow is useful for huge projects - it navigates your file selection to the document that is currently opened in the editing area on the right side.
  • The second button with the gear builds your currently selected target or project.
  • The third button with the gear and the small blue arrow installs your selection if you have install targets and rules defined - more details about that will be covered in the chapter about Build Systems.
  • The last button cleans up your selected target by executing make clean.
  • And finally, in the text field you can enter terms to filter the view. This does only work, if the search term you entered is at the start of any target, filename, or folder within your tree view.