aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHarald Sitter <sitter@kde.org>2017-07-13 10:11:54 +0200
committerHarald Sitter <sitter@kde.org>2017-07-13 13:26:27 +0200
commit5f6aa58b8067591d0f71c3b321e17ffc73dd7528 (patch)
treeea0db3ba961113415eea73c5b620c10c6047c211 /README.md
parent58dea7bfdcb801f099dac7fc052dc2ce08176030 (diff)
downloadextra-cmake-modules-5f6aa58b8067591d0f71c3b321e17ffc73dd7528.tar.gz
extra-cmake-modules-5f6aa58b8067591d0f71c3b321e17ffc73dd7528.tar.bz2
add a metainfo.yaml to make ECM a proper framework
Reviewers: ochurlaud, dfaure, skelly Reviewed By: dfaure Subscribers: #frameworks, #build_system Tags: #frameworks, #build_system Differential Revision: https://phabricator.kde.org/D6604
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..f62ba3e9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,17 @@
+# Extra CMake Modules
+
+## Introduction
+
+The Extra CMake Modules package, or ECM, adds to the modules provided by CMake,
+including ones used by ``find_package()`` to find common software, ones that
+can be used directly in ``CMakeLists.txt`` files to perform common tasks and
+toolchain files that must be specified on the commandline by the user.
+
+In addition, it provides common build settings used in software produced by the
+KDE community.
+
+While the driving force of this module is to reduce duplication in CMake scripts
+across KDE software, it is intended to be useful for any software that uses the
+CMake build system.
+
+For more information visit the documentation at https://api.kde.org/ecm/