Guidelines and HOWTOs/CMake: Difference between revisions

From KDE Community Wiki
No edit summary
(39 intermediate revisions by 10 users not shown)
Line 1: Line 1:
This is the central directory of all [http://www.cmake.org CMake]-related pages on TechBase.
Most KDE software uses [http://www.cmake.org CMake] as a buildsystem. This page is the starting point for CMake-related documentation for KDE software.


== KDE4 Specific CMake Documentation==
You should be aware that there are two main development platforms that KDE software is based on: the older kdelibs4, and its replacement, the [http://api.kde.org/frameworks-api/frameworks5-apidocs/ KDE Frameworks]. Quite a bit of KDE software is in the process of transitioning from kdelibs4 to KDE Frameworks, and the way CMake is used is slightly different between the two.


;[[Development/Tutorials/CMake|CMake tutorial]]
:''An introduction to using CMake for KDE4''


;[[Guidelines HOWTOs/CMake_FAQ|KDE's CMake FAQ]]
This page contains some tutorials to help you get started on building a CMake-based buildsystem. This is the recommended way of building your software if you use KDE technologies, such as KDE Frameworks.
:''Some Frequently Asked Questions''


;[[Policies/CMake_and_Source_Compatibility|Source compatiblity with CMake]]
==Beginners==
:''This page discusses what has to be taken care of in order to stay source compatible on the CMake level.''


;[[Policies/CMake_Coding_Style|Coding style for CMake files]]
* [[/FirstProject|A first CMake project]]: if you've never even looked at CMake code before, start here.
:''Some guidelines how to write CMake scripts in KDE.''
* [[/Frameworks|Using a framework]]: introduces you to using a KDE Framework - finding the package and linking your program against it.


;[[Automoc4|Automoc4]]
==Intermediate==
:''Automoc4 documentation.''


;[http://api.kde.org/cmake/modules.html KDE CMake modules API]
* [[/Library|Creating a library]]: demonstrates best practices when creating a library with a CMake-based buildsystem (such as a KDE Framework).
:''Documentation for all CMake modules in kdelibs (generated from kdelibs svn)''


;[[Development/KDE_and_CMake_Together|KDE4 CMake macros and variables]]
== Building with CMake in short ==
:''Documentation for the macros and variables for building KDE4 software, provided by FindKDE4Internal.cmake (manually written)""


==More Places to learn about CMake==
If you just want to build a CMake-based project on a UNIX system, the following recipe will do that:


Here are some good places to learn about CMake in general:
<syntaxhighlight lang="bash">
* [http://www.cmake.org/HTML/Documentation.html CMake Manual]
cd /path/to/project/source
* [http://www.cmake.org/Wiki/CMake CMake Wiki]
mkdir build
* [http://www.cmake.org/Wiki/CMake_HowToDoPlatformChecks CMake System Checks ]
cd build
* [http://www.cmake.org/Wiki/CMake_HowToFindInstalledSoftware Finding Optional Packages ]
cmake -DCMAKE_INSTALL_PREFIX=/where/to/install/to ..
* [http://www.cmake.org/Wiki/HowToBuildKDE4Software KDE 4 Tutorial at the CMake Wiki ]
make
* [http://www.cmake.org/Wiki/CMake_FAQ CMake FAQ]
make install
* [http://www.elpauer.org/stuff/learning_cmake.pdf Slides for the "Learning CMake" seminar]
</syntaxhighlight>
* [http://mail.kde.org/pipermail/kde-buildsystem/ The kde-buildsystem Mailing List Archive]


Also, consider joining the [http://www.cmake.org/mailman/listinfo/cmake CMake mailing list].
Don't forget to replace both paths. If you want an explanation of what this command does and how to make CMake behave differently, or you want to build on Windows or OS/X, see [[/Building | the building with CMake]] chapter.
 
==Useful resources==
 
You may want to check out the [http://www.cmake.org/Wiki/CMake CMake wiki], although beware that it contains quite a bit of out-of-date information.
 
===Reference documentation===
* [http://www.cmake.org/HTML/Documentation.html CMake's own documentation]
* [http://api.kde.org/ecm Extra CMake Modules documentation]
 
===Upgrading from KDELibs4===
See https://techbase.kde.org/ECM5/IncompatibleChangesKDELibs4ToECM.
 
===FAQs===
 
* [[/FAQs|KDE's CMake FAQs]]
* [http://www.cmake.org/Wiki/CMake_FAQ CMake FAQ on the CMake wiki]
 
===Mailing lists===
 
;[http://mail.kde.org/pipermail/kde-buildsystem/ The kde-buildsystem mailing list]
:Discussion of CMake in the KDE community, as well as development of Extra CMake Modules.
;[http://www.cmake.org/mailman/listinfo/cmake CMake mailing list]
:For users of CMake.
;[http://www.cmake.org/mailman/listinfo/cmake-developers CMake mailing list]
:For anyone wanting to contribute to CMake.

Revision as of 17:18, 10 March 2016

Most KDE software uses CMake as a buildsystem. This page is the starting point for CMake-related documentation for KDE software.

You should be aware that there are two main development platforms that KDE software is based on: the older kdelibs4, and its replacement, the KDE Frameworks. Quite a bit of KDE software is in the process of transitioning from kdelibs4 to KDE Frameworks, and the way CMake is used is slightly different between the two.


This page contains some tutorials to help you get started on building a CMake-based buildsystem. This is the recommended way of building your software if you use KDE technologies, such as KDE Frameworks.

Beginners

  • A first CMake project: if you've never even looked at CMake code before, start here.
  • Using a framework: introduces you to using a KDE Framework - finding the package and linking your program against it.

Intermediate

  • Creating a library: demonstrates best practices when creating a library with a CMake-based buildsystem (such as a KDE Framework).

Building with CMake in short

If you just want to build a CMake-based project on a UNIX system, the following recipe will do that: 

cd /path/to/project/source
mkdir build
cd build
cmake -DCMAKE_INSTALL_PREFIX=/where/to/install/to ..
make
make install

Don't forget to replace both paths. If you want an explanation of what this command does and how to make CMake behave differently, or you want to build on Windows or OS/X, see the building with CMake chapter.

Useful resources

You may want to check out the CMake wiki, although beware that it contains quite a bit of out-of-date information.

Reference documentation

Upgrading from KDELibs4

See https://techbase.kde.org/ECM5/IncompatibleChangesKDELibs4ToECM.

FAQs

Mailing lists

The kde-buildsystem mailing list
Discussion of CMake in the KDE community, as well as development of Extra CMake Modules.
CMake mailing list
For users of CMake.
CMake mailing list
For anyone wanting to contribute to CMake.
Retrieved from "https://community.kde.org/index.php?title=Guidelines_and_HOWTOs/CMake&oldid=52440"