Commit 1d91c455 authored by Mike Kremer's avatar Mike Kremer

Added documentation on how to build example plugin with cmake.

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@7218 383ad7c9-94d9-4d36-a494-682f7c89f535
parent 8b3a7e5e
include (plugin)
openflipper_plugin ()
\ No newline at end of file
openflipper_plugin ( [DIRS dir1 dir2 ...]
[DEPS dep1 dep2 ...]
[OPTDEPS dep1 dep2 ...]
[LDFLAGSADD flag1 flag2 ...]
[CFLAGSADD flag1 flag2 ...]
[LIBRARIES lib1 lib2 ...]
[LIBDIRS dir1 dir2 ...]
[INCDIRS dir1 dir2 ...]
[ADDSRC file1 file2 ...]
[INSTALLDATA dir1 dir2 ...]
[TRANSLATION_LANGUAGES lang1 lang2 ...]
[TRANSLATION_ADDFILES file1 file2 ...]
[LICENSEMANAGER])
DIRS = additional directories with source files
DEPS = required dependencies for find_package macro
OPTDEPS = optional dependencies for find_package macro
LDFLAGSADD = flags added to the link command
CFLAGSADD = flags added to the compile command
LIBRARIES = libraries added to link command
LIBDIRS = additional link directories
INCDIRS = additional include directories
ADDSRC = additional source files
INSTALLDATA = directories that will be installed into the openflipper data directory
TRANSLATION_LANGUAGES = language codes for translation
TRANSLATION_ADDFILES = additional files that should be included into the translation files
LICENSEMANAGER = Compile plugin with license management
\ No newline at end of file
......@@ -6,6 +6,7 @@
* - \ref geometryData
* \section tuts Tutorials
* - \ref ex1
* - \ref ex1c
* - \ref ex1b
* - \ref ex2
* - \ref ex3
......
......@@ -57,10 +57,34 @@
* simplePlugin.cc
* \include example/simplePlugin.cc
*
* \section ex1b How to build the plugin with qmake
*
* The only thing that's still left to be created is our qmake project file
* that is used to generate the Makefiles for the plugin. For general information on how to build
* \section ex1c How to build the plugin with cmake (recommended)
*
* The only thing that's still left to be created is our cmake project file
* that is used to generate the Makefiles for the plugin.
* This step is very easy, so let's start. In your plugin's root directory
* create a CMakeLists.txt file.
*
* Our first line includes OpenFlipper's predefined cmake plugin functions. This allows us to simply call
* \c openflipper_plugin() macro in order to build our code as a plugin. Our project file then looks like this:
*
* CMakeLists.txt
* \include example/CMakeLists.txt
*
* Note that you have several options that can be passed to the openflipper_plugin() function:
* The usage of this function is:
*
* \include example/cmake_plugin_usage.txt
*
* See the cmake documentation for detailed information on the different parameters.
*
* Now, when building OpenFlipper with cmake, your plugin should be found and built automatically.
*
* \section ex1b How to build the plugin with qmake (obsolete)
*
* If you use QMake to generate your makefiles, you can drop the previous section.
* Note: Using QMake as build system has become obsolete since OpenFlipper 1.0 RC1.
* For general information on how to build
* OpenFlipper with qmake see \ref buildingOpenFlipper.
* So lets get started! First off we create a file \c Plugin-SimplePlugin.pro in the plugins's directory.
* It is mandatory to name the project file after the project's directory.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment