Skip to content
Snippets Groups Projects
Commit fb18d125 authored by Stephan Schulz's avatar Stephan Schulz
Browse files

update example project documentation

parent 033b0ab9
No related branches found
No related tags found
1 merge request!15CMake projectconfig
Pipeline #58117 canceled
...@@ -3,14 +3,15 @@ ...@@ -3,14 +3,15 @@
Examples Examples
======== ========
In the ``/examples`` sub directory several C++ and Fortran example In the ``/examples`` sub directory several C++ and Fortran example
programs are placed. programs are place, as well as example projects.
Projects Projects
-------- --------
To show how to integrate our library into your project, there are example
CMake and GNU make projects.
CMake CMake
^^^^^ ^^^^^
In the ``/examples`` directory are two example CMake projects. One uses a In the ``/examples`` directory are two example CMake projects. One uses a
separately installed (or at least compiled) ALL, and the other includes separately installed (or at least compiled) ALL, and the other includes
the library as a subdirectory and builds it along with the main project. 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 ...@@ -63,6 +64,17 @@ automatically be build, but also to be rebuild every time the build
directory is cleaned. 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 Programs
-------- --------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment