commit 34e19396e1a4a5a1bb37757c9665a55b8389ffe7 parent 4c0729269800ca3311d4e624f468c48ae8697499 Author: Jean Pierre Cimalando <jp-dev@inbox.ru> Date: Fri, 21 May 2021 22:37:21 +0200 cmake: add usage documentation Diffstat:
| M | cmake/DPF-plugin.cmake | | | 27 | +++++++++++++++++++++++++++ |
1 file changed, 27 insertions(+), 0 deletions(-)
diff --git a/cmake/DPF-plugin.cmake b/cmake/DPF-plugin.cmake @@ -3,6 +3,33 @@ # # SPDX-License-Identifier: ISC +# ------------------------------------------------------------------------------ +# CMake support module for the DISTRHO Plugin Framework +# +# The purpose of this module is to help building music plugins easily, when the +# project uses CMake as its build system. +# +# In order to use the helpers provided by this module, a plugin author should +# add DPF as a subproject, making the function `dpf_add_plugin` available. +# The usage of this function is documented below in greater detail. +# +# Example project `CMakeLists.txt`: +# +# ``` +# cmake_minimum_required(VERSION 3.7) +# project(MyPlugin) +# +# add_subdirectory(DPF) +# +# dpf_add_plugin(MyPlugin +# TARGETS lv2 vst +# UI_TYPE opengl +# FILES_DSP +# src/MyPlugin.cpp +# FILES_UI +# src/MyUI.cpp) +# ``` + include(CMakeParseArguments) # ------------------------------------------------------------------------------