From fb18d1255268e459ccde45bef144ff814a011761 Mon Sep 17 00:00:00 2001 From: Stephan Schulz <stephan.schulz-x2q@rub.de> Date: Mon, 25 Jan 2021 16:31:37 +0100 Subject: [PATCH] update example project documentation --- docs/Examples.rst | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/Examples.rst b/docs/Examples.rst index 1bab441..9e325fb 100644 --- a/docs/Examples.rst +++ b/docs/Examples.rst @@ -3,14 +3,15 @@ Examples ======== In the ``/examples`` sub directory several C++ and Fortran example -programs are placed. +programs are place, as well as example projects. Projects -------- +To show how to integrate our library into your project, there are example +CMake and GNU make projects. CMake ^^^^^ - In the ``/examples`` directory are two example CMake projects. One uses a separately installed (or at least compiled) ALL, and the other includes the library as a subdirectory and builds it along with the main project. @@ -63,6 +64,17 @@ automatically be build, but also to be rebuild every time the build directory is cleaned. +GNU Make +^^^^^^^^ +An example of integrating ALL into a traditional GNU Makefile project is +shown in ``/example/MakefileProject``. A symbolic link to the VTK +installation directory is assumed to exist as ``vtk_bin``, otherwise the +Makefile must be updated (see ``VTK_DIR``). It also assumes its directory +in the source tree as relative position to the ALL source directory. +Moving the project needs updating of ``ALL_SOURCE``. It will automatically +compile ALL using the options provided in ``LIBALL_CONFIGURE``. + + Programs -------- -- GitLab