Page MenuHomePhabricator

Update MITK documentation on CMAKE build for plugins
Closed, ResolvedPublic

Description

The documentation instructions on the CMAKE_FAQ page needs update.
The steps on activating a new plugin are not precise enough for new users/developers.

Event Timeline

a178n triaged this task as Low priority.Mar 10 2021, 8:19 AM
a178n created this task.

I want to use a plugin, how do I activate it?

  1. Navigate to the MITK-build folder inside your super build folder.

    For eg. cd ~/MITK-superbuild/MITK-build
  2. Start CMake.

    For eg. cmake-gui . or ccmake .
  3. Configure, if necessary for all the variables to be displayed.
  4. Find the variable MITK_BUILD_<plugin-id> and activate it. The plugin-id is the package name of the plugin. For eg. org.mitk.core.ext. (Refer the MITK/Plugins directory)
  5. Configure, again.
  6. Generate.
  7. Rebuild MITK-build target using your development environment.

    For eg. make -j4

Changes are pushed into the new branch T28353-cmake_faq branch.

could you make an arc diff. Then it is easier to review and comment in code. Thanks.