PID_Framework(AUTHOR ... YEAR ... LICENSE ... DESCRIPTION ... ADDRESS ... SITE ... [OPTIONS])¶
declare_PID_Framework(AUTHOR ... YEAR ... LICENSE ... DESCRIPTION ... ADDRESS ... SITE ... [OPTIONS])¶
- Declare the current CMake project as a PID framework.
AUTHOR <name>: The name of the author in charge of maintaining the framework. YEAR <dates>: Reflects the lifetime of the package, e.g.
YYYYis the creation year and
ZZZZthe latest modification date.
LICENSE <license name>: The name of the license applying to the framework. This must match one of the existing license file in the
licensesdirectory of the workspace.
DESCRIPTION <description>: A short description of the framework. ADDRESS <url>: The url of the framework’s repository. Must be set once the package is published. SITE <url>: The url where to find the static site generated by the framework.
INSTITUTION <institutions>: Define the institution(s) to which the framework maintainer belongs to. MAIL <e-mail>: E-mail of the maintainer author. PROJECT <url>: The url of the online git repository project page where to find source code of the framework. LOGO <path to image file>: The path to the image used as logo for the framework. This path is relative to framework src/assets folder. BANNER <path to image file>: The path to the image used as a banner for the framework index page. This path is relative to framework src/assets folder. WELCOME <path to markdown file>: The path to the mardown use for the welcome. This path is relative to framework src/pages folder.
- This function must be called in the root CMakeLists.txt file of the framework, before any other call to PID framework API.
- Exactly one call to this macro is allowed.
EffectsInitialization of framework’s internal state: after this call the framework’s content is ready to be defined.
ExamplePID_Framework( AUTHOR Robin Passama MAIL firstname.lastname@example.org INSTITUTION LIRMM ADDRESS email@example.com:pid/pid-framework.git YEAR 2016 LICENSE CeCILL-C DESCRIPTION "PID is a global development methodology supported by many tools inclusing a CMake API and dedicated C++ projects." SITE https://pid.lirmm.net/pid-framework PROJECT https://gite.lirmm.fr/pid/pid-framework LOGO img/pid_logo.jpg BANNER img/cooperationmechanisms.jpg )
- Define a new category for classifying packages of the current framework.
<string>: specifies the category and (optionally) subcategories to which a package of the framework can belong to.
- This function must be called in the root CMakeLists.txt file of the package, after declare_PID_Framework and before build_PID_Framework.
EffectsRegister a new category into the framework. This information will be added to the framework reference file when it is generated.
- Configure PID framework according to previous information.
- This function must be the last one called in the root CMakeList.txt file of the framework.
EffectsThis function launch the configuration of the framework build process.