A PID framework provides a little set commands to manage its lifecycle. All these commands must be called from the build folder of the framework.

Before being able to use this command, they must be configured from CMake configuration script defined in the CMakeLists.txt of the framework:

cd <workspace dir>/sites/frameworks/<framework name>/build
cmake .. #building commands

Once this last command has been executed, developers can use native build tool to execute framework specific commands that are defined by PID system. We suppose here we use the make tool but any other tool can be used the same way.

The commands are simply called using built tool specific targets, that are listed below.

Commands summary

  • make build: building the static site using jekyll.
  • make serve: Looking at the resulting static web site in your web browser.
  • make referencing: Referencing the framework in the workspace.

Building the static site

  • Call: make build
  • Effect: generates the static site described by the framework using the jekyll tool.
  • Arguments: none

Looking at the resulting static site

  • Call: make serve
  • Effect: serve the resulting static website into a local server. Look at the output of the command to know the URL where to find this site.
  • Arguments: none

Referencing the framework in the workspace

  • Call: make referencing
  • Effect: generates the reference file for the framework and places it in the adequate folder of the workspace. When done, the framework is known in the local workspace and will be known by all users when workspace official repository will be updated accordingly.
  • Arguments: none